Guia do usuário do Marketplace

Última atualização 5 de set de 2024

Como autenticar

A autenticação com a API do UiPath Orchestrator depende do tipo de instância do Orchestrator à qual você está se conectando. Há dois tipos de instâncias do Orchestrator, ambos usando um token de portador para autenticação: Cloud Orchestrator e On-premise Orchestrator.

Pontos de extremidade 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

Observação: Cloud Orchestrator: para obter mais informações sobre como um usuário pode localizar seu ID do cliente, Chave do usuário, Nome lógico da conta e Nome lógico do tenant, consulte Obtenção de informações de acesso à API na documentação da API do Orchestrator.

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.

Se um usuário insere um valor de Pasta , você precisa recuperar o OrganizationUnitId da pasta. Esse identificador deve ser incluído no Cabeçalho de todas as solicitações de API subsequentes após a conclusão da autenticação.

Como posso obter o valor de OrganizationUnitId da pasta?

Para recuperar o OrganizationUnitId, você deve ter o Nome da Pasta e seguir as solicitações de API listadas abaixo.

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

Quando o nome de usuário do usuário é conhecido, você também pode 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.

Usando as credenciais inseridas, recupere o IDdoUsuário do usuário enviando uma solicitação GET para o ponto de extremidade GetCurrentUser (por exemplo, {{base url}}/Users/Users_GetCurrentUser).
Depois de recuperar a resposta GET que contém o IDdoUsuário, envie uma solicitação GET para o endpoint GetUsersForFolder usando o Nome da pasta e o IDdoUsuário como 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).

Usando o nome de usuário inserido, envie uma solicitação GET para o endpoint GetAllRolesForUserByUsernameAndSkupAndTke (por exemplo, {{base url}}/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{{username}}',skip=0,take=0)).
- A resposta inclui todas as pastas que o usuário tem permissão para acessar. Ao analisar a resposta, você pode verificar se ela inclui o nome da pasta que o usuário inseriu e/ou o OrganizationUnitId que foi recuperado em uma solicitação anterior.
- O benefício de usar essa opção é que você pode obter o OrganizationUnitId da pasta e verificar as permissões em uma única solicitação.

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.