Resolver entidade de diretório por nome

Resolva ponto de extremidade da API da entidade do diretório por nome para pesquisar uma única entidade do diretório por nome e tipo usando a ID da organização no Test Cloud.

Resolve uma única entidade de diretório por seu nome e tipo, com base no ID da organização.

Ponto de Extremidade da API

POST {accessURL}/{organizationName}/identity_/api/Directory/ResolveByName/{partitionGlobalId}

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Test Cloud	https://cloud.uipath.com/
Test Cloud para o Setor Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer os seguintes escopos:

• PM.Diretório

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Observação:

Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
partitionGlobalId (obrigatório)	String (GUID)	O ID da organização para resolver a entidade.

Corpo da Solicitação

O corpo da solicitação especifica a entidade a ser resolvida por nome.

{
    "entityName": "string",
    "entityType": "User"
}

Propriedade	Tipo de dados	Description
entityName (obrigatório)	String	O nome da entidade de diretório (por exemplo, endereço de e-mail para usuários, nome do grupo para grupos).
entityType (obrigatório)	String	O tipo de entidade do diretório. Valores válidos: User, Group, Application.

Resposta

200 OK

Retorna a entidade do diretório completo. O formato da resposta é o mesmo que o ponto de extremidade Resolver (varia de acordo com o tipo de entidade).

404 Não encontrado

Retornado quando a entidade ou a partição não podem ser encontradas.

Exemplo de solicitação

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

• Seu {baseURL} é: https://cloud.uipath.com/{organizationName}/identity_
• Seu {access_token} é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Você deseja resolver um usuário pelo seu email [e-mail].

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/ResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityName": "[e-mail]",
    "entityType": "User"
}'

Aqui está o body da resposta de uma chamada bem-sucedida:

{
    "objectType": "DirectoryUser",
    "source": "aad",
    "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "[e-mail]",
    "email": "[e-mail]",
    "displayName": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "jobTitle": "Software Engineer",
    "companyName": "Contoso",
    "city": "Seattle",
    "department": "Engineering",
    "isActive": true,
    "creationTime": "2025-01-15T10:30:00Z"
}