- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
Resolver entidades de diretório em massa por API de nome no Test Cloud para resolver várias entidades de diretório do mesmo tipo em uma única solicitação por ID de organização.
Resolve várias entidades de diretório por seus nomes em uma única solicitação, com base no ID da organização. Todas as entidades na solicitação devem ser do mesmo tipo.
Ponto de Extremidade da API
POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolveByName/{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'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
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 as entidades internas. |
Corpo da Solicitação
O corpo da solicitação especifica os nomes de entidade a serem resolvidos. Ao contrário do BulkResolve, todas as entidades devem ser do mesmo tipo.
{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User",
"scope": null
}
{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User",
"scope": null
}
| Propriedade | Tipo de dados | Description |
|---|---|---|
entityNames (obrigatório) | Matriz de strings | Os nomes das entidades de diretório a serem resolvidas (por exemplo, endereços de email para usuários, nomes de grupos para grupos). |
entityType (obrigatório) | String | O tipo de todas as entidades na solicitação. Valores válidos: User, Group, Application. |
scope (opcional) | String | Escopo opcional para entidades do Active Directory. |
Resposta
200 OK
Retorna um dicionário que mapeia cada nome de entidade para sua entidade de diretório resolvida. As entidades que não puderam ser resolvidas são retornadas como null.
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}
400 Bad Request
Retornado quando os parâmetros obrigatórios estão ausentes ou são inválidos.
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 dois usuários por seus endereços de email.
A chamada deve ser semelhante ao seguinte exemplo (cURL):
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User"
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityNames": [
"john.doe@example.com",
"jane.smith@example.com"
],
"entityType": "User"
}'
Aqui está o body da resposta de uma chamada bem-sucedida:
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}
{
"john.doe@example.com": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"jane.smith@example.com": null
}