Resolver entidade do diretório

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

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

Ponto de Extremidade da API

POST {accessURL}/{organizationName}/identity_/api/Directory/Resolve/{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 <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-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.

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

Propriedade	Tipo de dados	Description
entityId (obrigatório)	String	O identificador exclusivo da entidade do diretório.
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 varia com base no tipo de entidade.

Resposta do usuário

{
    "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"
}

Resposta do grupo

{
    "objectType": "DirectoryGroup",
    "source": "aad",
    "identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "Engineering Team",
    "email": null,
    "displayName": "Engineering Team",
    "externalId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

Resposta do aplicativo

{
    "objectType": "DirectoryApplication",
    "source": "aad",
    "identifier": "aad|c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "My Application",
    "email": null,
    "displayName": "My Application",
    "applicationId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}

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 <your-access-token> é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Você deseja resolver um usuário com ID aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890.

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

curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/Resolve/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityId": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "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"
}