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:

We support authentication through ROPC for backwards compatibility for Orchestrator instances that have been migrated from standalone to Automation Suite deployments.Only Host administrators should authenticate using the /api/account/authenticate/ endpoint.Business users should authenticate using External Applications.

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:

   If your organization uses the Azure Active Directory model, you must register external applications in Orchestrator and use the OAuth flow.

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, https://{yourDomain} /swagger/ui/index#/.

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

Importante:

API access with Windows Auto-logon (NTLM authentication) has been removed, as indicated in the deprecation timeline.

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

If the external application is already registered, refer to Using OAuth for External Apps.