Autenticando

O sistema de autenticação para a API UiPath Orchestrator usa um token de portador para usuários locais e autenticação NTLM para usuários de diretório.

Nota: Por padrão, o token do portador expira após 30 minutos.

Importante:

As instruções nesta página se aplicam apenas à API do Orchestrator local. A autenticação básica para API não tem suporte para tenants do Orchestrator do Automation Cloud.

Se você estiver usando o serviço do Orchestrator em Automation Cloud , use as instruções em Consuming Cloud API em vez disso.

Autenticação de usuário local por meio de um token de portador

1. Faça uma solicitação POST para o terminal {OrchestratorURL}/api/account/authenticate com suas credenciais de login do orquestrador, como no exemplo abaixo.
   POST {OrchestratorURL}/api/account/authenticate

   Request headers:

   Chave	Valor
   Autorização	O portador

   Request body:

   {
       "tenancyName" : "Documentation",
       "usernameOrEmailAddress" : "Documentation",
       "password" : "DocumentationAPItest"
   }

   Código de resposta: 200 OK

   Response body:

   {
       "result": "Rr22VaC0D6MkzFShb0gKqaw3vYUJSMmo4jJWk5crDYtSbZkxPFuOC9ApMEnug2q8WxEGPkVwmNoaSXzxOBwia1Ecrldg5BUXXErU_VNOo_yt7X_GDF8sMTyErSqO9Gfe7RSinIueQU6Q_axlY4jDnCP5r2LHrAJVdyM8Tg9x3WHnR8MOgeOl290uTsSOM1ezGG-OmFarRqFUPiN2-iE_mo1KNW-9AmT87-p1-ZYTusLaGyTS9jKVGtRhMjjB0l9VyOFvINhjptq8zotCo5cOOVWJeuvh-307ZdcUWHxkFTwoGDS_DpC4D7JrKfp4oWeSkA0SSy95RfzT8KRTmsJGQV0k8VD6HE3aa_7c-FGrCDjRVtDSkTgpQcQFrIXD8kT4P52a_18doKaSB-asQ8scYe_o73fCL4VtqLDb2ZWlAwEChVmorcFjbXnejxuAubjoKaoJH10gzc5_IiCPI8pM-Zm09Z5D1ljsNjWJ_LrmOR3dijuuKUGvCDtyCCCU_JrPRxmdYSXZmHHx_3joAux0-A",
       "targetUrl": null,
       "success": true,
       "error": null,
       "unAuthorizedRequest": false,
       "__abp": true
   }

2. Copie a string no parâmetro de resultado da resposta HTTP para a área de transferência. Isso representa o token do portador e pode ser usado em todas as solicitações futuras da seguinte maneira:
   • Como um cabeçalho de autorização com o valor Bearer xxxxxxxxxxxxx , em que xxxxxxxxxxxxx representa a cadeia copiada anteriormente;
   • Se sua ferramenta de teste de API for compatível, selecione o tipo de autorização de token de portador e insira a sequência copiada anteriormente.

Autenticação de usuário de domínio via autenticação NTLM

Importante: para autenticar suas solicitações usando credenciais do Windows, você precisa usar um cliente API que suporte autenticação NTLM, como Postman.

1. Faça uma solicitação para o endpoint desejado especificando suas credenciais do Windows no cliente de API dedicado. Para alterar um cabeçalho de autenticação NTLM no Postman, navegue até a guia Auth , defina o Type como NTLM Authenticatione preencha os campos Username e Password .
   
   

   

   
   
2. Se o usuário existir em vários locatários, especifique o exato usando o cabeçalho X-UIPATH-TenantName , caso contrário, a solicitação será executada no primeiro locatário em que o usuário foi provisionado. O exemplo a seguir ilustra uma solicitação GET para o ponto de extremidade {OrchestratorURL}/odata/Processes no locatário financeiro.
   OBTER {OrchestratorURL}/odata/Processes

   Request headers:

   Chave	Valor
   Autorização	O portador
   X-UIPATH-TenantName	O nome do inquilino. Por exemplo, "Finanças".

   Código de resposta: 200 OK

   Response body:

   {
       "@odata.context": "{OrchestratorURL}/odata/$metadata#Processes",
       "@odata.count": 2,
       "value": [
           {
               "IsActive": false,
               "SupportsMultipleEntryPoints": false,
               "RequiresUserInteraction": true,
               "Title": null,
               "Version": "1.0.6981.35861",
               "Key": "QueueItemsProcessing:1.0.6981.35861",
               "Description": "Process items from an Orchestrator queue.",
               "Published": "2020-10-17T14:22:11.0566667Z",
               "IsLatestVersion": false,
               "OldVersion": null,
               "ReleaseNotes": null,
               "Authors": "petrina.smith",
               "ProjectType": "Undefined",
               "Id": "QueueItemsProcessing",
               "Arguments": {
                   "Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
                   "Output": null
               }
           },
           {
               "IsActive": false,
               "SupportsMultipleEntryPoints": false,
               "RequiresUserInteraction": false,
               "Title": "TestingSequence",
               "Version": "4.0.6",
               "Key": "TestingSequence:4.0.6",
               "Description": "Blank Process",
               "Published": "2020-10-17T13:04:06.6766667Z",
               "IsLatestVersion": false,
               "OldVersion": null,
               "ReleaseNotes": "Invoke WF Action Generator",
               "Authors": "petrina.smith",
               "ProjectType": "Process",
               "Id": "TestingSequence",
               "Arguments": {
                   "Input": "[{\"name\":\"Name\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"Email\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"Product\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false}]",
                   "Output": null
               }
           }
       ]
   }

Acesso ao Swagger

Se você estiver usando o Swagger para experimentar nossa API, basta fazer login em sua instância do Orchestrator em uma guia separada.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, {baseURL2} /swagger/ui/index#/.

Observação: a autenticação Swagger expira de acordo com os parâmetros definidos em sua instância do Orchestrator. Por padrão, é definido como 30 minutos. Você pode alterá-lo modificando o valor do parâmetro Auth.Cookie.Expire , no arquivo Web.config .