Autenticando

A Autenticação de API garante que apenas partes autorizadas possam interagir com os recursos disponíveis e realizar ações necessárias. A UiPath oferece vários métodos de autenticação para diferentes cenários.

Saiba mais sobre os métodos de autenticação disponíveis no guia do Automation Suite.

Autenticação de usuário local por meio de um token de portador (autenticação ROPC)

Importante: somos compatíveis com a autenticação por meio de ROPC para compatibilidade retroativa para instâncias do Orchestrator que foram migradas de implantações autônomas para o Automation Suite. Apenas Aministradores do host devem se autenticar usando o ponto de extremidade /api/account/authenticate/. Usuários Business devem se autenticar usando Aplicativos externos.

O método de autenticação de credenciais de senha do proprietário do recurso tem escopo de locatário, portanto, o aplicativo externo não poderá ser autenticado usando esse método, pois um aplicativo externo não pode ser criado no nível do locatário.

1. Para recuperar o token de acesso, faça uma solicitação POST para o terminal {OrchestratorURL}/api/account/authenticate com a seguinte carga útil:

   {
       "TenancyName": "{account_tenancy_name}",
       "UsernameOrEmailAddress": "{account_username}",
       "Password": "{account_password}"
   }

   No pedido acima:

   • {account_tenancy_name}— é o identificador exclusivo do locatário em sua conta do Automation Suite
   • {account_username}— é o nome de usuário da sua conta do Automation Suite
   • {account_password}— é a senha usada para fazer login em sua conta do Automation Suite
2. Para encontrar o valor TenancyName de sua instância do orquestrador, faça uma solicitação GET para o terminal /odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser .
   O corpo da resposta retorna o token do portador, usado por seu aplicativo para autorizar outras chamadas de API. Portanto, no cabeçalho de autorização de uma chamada de API, anexe Bearer xxxx e substitua xxxx pelo valor {access_token} (por exemplo, Authorization: Bearer eyJhbG ... LnVxjA).

   {
       "result": "{access_token}",
       "targetUrl": null,
       "success": true,
       "error": null,
       "unAuthorizedRequest": false,
       "__abp": true
   }

   Por padrão, o token de acesso é válido por 30 minutos. Para gerar um novo, faça outra chamada para o terminal api/account/authenticate .

   Importante: se sua organização usar o modelo do Azure Active Directory, você deve registrar aplicativos externos no Orchestrator e usar o fluxo do OAuth.

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.

A definição do Swagger da API do Orchestrator pode ser acessada adicionando o sufixo /swagger/ui/index#/ ao URL do Orchestrator. Por exemplo, /swagger/ui/index#/https://{yourDomain}.

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 .

Autenticação de usuário de domínio

Importante:

O acesso à API com logon automático do Windows (autenticação NTLM) foi removido, conforme indicado na linha do tempo de descontinuação.

Recomendamos que você use o fluxo OAuth, que requer o registro de aplicativos externos no Orchestrator.

Se o aplicativo externo já estiver registrado, consulte .