Como autenticar

Autentique com a API do UiPath Orchestrator usando tokens de portador para instâncias do Cloud Orchestrator e do On-premise Orchestrator.

Authenticating with UiPath Orchestrator API is dependent on the type of Orchestrator instance that you're connecting to. There are two types of Orchestrator instances, both of which use a bearer token for authentication: Cloud Orchestrator and On-premise Orchestrator.

Endpoints e entradas

De uma perspectiva de autenticação, há duas diferenças principais entre os tipos de instância. O primeiro é o endpoint para o qual você envia solicitações, e o segundo são as entradas necessárias para as solicitações de autenticação.

A tabela abaixo mostra os diferentes pontos de extremidade e entradas para cada tipo de instância, além de links para a documentação da API aplicável.

	Cloud Orchestrator	On-Premise Orchestrator
Endpoint	https://account.uipath.com/oauth/token	https://{{orchestrator-url}}/api/Account/Authenticate
Entradas	Nome Lógico da Conta Nome Lógico do Tenant ID do Cliente Chave de Usuário Pasta (opcional)	URL do Orchestrator Nome do tenant do Orchestrator Email ou Nome de Usuário Senha Pasta (opcional)
Solicitação/Resposta	API arrogância Postman	API arrogância Postman

:::note Cloud Orchestrator: For more information about how a user can locate their **Client Id**, **User Key**, **Account Logical Name**, and **Tenant Logical Name**, see [Getting the API Access Information](https://docs.uipath.com/pt-BR/orchestrator/reference/consuming-cloud-api#section-getting-the-api-access-information-from-the-cloud-platform-s-ui) in the Orchestrator API documentation. :::

Pastas

Ambos os tipos de instância incluem uma entrada de Pasta opcional. As pastas permitem que você mantenha controle otimizado sobre automações e suas entidades intrínsecas e pessoal em toda a organização. Há dois tipos de pastas disponíveis no Orchestrator: Clássica e Moderna. As pastas clássicas são habilitadas por padrão, enquanto a funcionalidade de pastas modernas deve ser habilitada pelo administrador do Host ou Tenant.

If a user enters a Folder value, you need to retrieve the OrganizationUnitId of the folder. This identifier must be included in the Header of all subsequent API requests after authentication is completed.

Como posso obter o valor de OrganizationUnitId da pasta?

To retrieve the OrganizationUnitId you must have the Folder Name and follow the API requests listed below.

1. Usando o Nome da pasta como seu parâmetro de entrada, envie uma solicitação GET para o ponto de extremidade GetFolders (por exemplo, {{base url}}/odata/Folders?$filter=FullyQualifiedName eq '{{FolderName}}').

   Quando o nome de usuário do usuário for conhecido, você também poderá recuperar o OrganizationUnitId da pasta e verificar suas permissões em uma única solicitação. Para obter mais informações, consulte abaixo.

Como verifico as permissões das pastas?

Há várias maneiras de verificar se um usuário tem permissão para acessar uma pasta específica. A maneira como você verifica as permissões depende de se você tem ou não o nome de usuário (não o e-mail) do usuário.

Opção 1: nome de usuário desconhecido

Essa opção se aplica às instâncias do Cloud Orchestrator, bem como às instâncias do On-Premise Orchestrator nas quais apenas o e-mail do usuário é conhecido.

1. Usando as credenciais inseridas, recupere o UserId do usuário enviando uma solicitação GET para o endpoint GetCurrentUser (por exemplo, {{base url}}/Users/Users_GetCurrentUser).
2. Depois de recuperar a resposta GET que contém o UserId, envie uma solicitação GET para o endpoint GetUsersForFolder usando o Nome da pasta e o UserId como seus parâmetros de entrada (por exemplo, {{base url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={{*FolderOrganizationUnitId*}},includeInherited=true)?$filter=Id eq {{userId}}).

Opção 2: nome de usuário conhecido

Essa opção se aplica a instâncias nas quais o nome de usuário é conhecido (normalmente, isso se aplica apenas às instâncias do On-Premise Orchestrator).

1. Usando o nome de usuário inserido, envie uma solicitação GET para o endpoint GetAllRolesForUserByUsernameAndSkipAndTake (por exemplo, {{base url}}/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{{username}}',skip=0,take=0)).
   • The response includes all of the folders the user has permission to access. By parsing the response, you can verify that it includes the Folder Name the user entered and/or the OrganizationUnitId that was retrieved in a previous request.
   • The benefit of using this option is that you can get the OrganizationUnitId of the folder and verify permissions in a single request.

Vários usuários

Um conector pode ter várias conexões autenticadas com o mesmo tenant do Orchestrator ou diferentes. O propósito das várias conexões é permitir que mais de um usuário acesse e use as funcionalidades do conector implementadas (por exemplo, inicie um trabalho, adicione itens da fila) sem compartilhar suas credenciais do Orchestrator.

Exemplos

Esta seção fornece links para o exemplo de interfaces de usuário do conector e as solicitações de API do Orchestrator correspondentes para cada campo de entrada.

• Autenticar - Cloud Orchestrator
• Autenticar - On-Premise Orchestrator
• Autenticar - On-Premise Orchestrator com pasta