- Primeros pasos
- Autenticación
- Ámbitos y permisos
- API de gestión de plataformas
Guía de la API de UiPath Automation Cloud
Resuelve varias entidades de directorio por sus identificadores y tipos únicos en una sola solicitud, en función del ID de la organización.
Punto final de API
POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolve/{partitionGlobalId}
Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:
| Cloud Platform | URL de acceso |
|---|---|
| Automation Cloud | https://cloud.uipath.com/ |
| Sector público de Automation Cloud | https://govcloud.uipath.us/ |
| Automation Cloud dedicado | https://{customURL}.dedicated.uipath.com/ |
Ámbitos
Necesita los siguientes ámbitos:
- PM.Directorio
Solicitar encabezados.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.
Parámetros de ruta
| Parámetros de ruta | Tipo de datos | Descripción |
|---|---|---|
partitionGlobalId (obligatorio) | Cadena (GUID) | El ID de la organización para resolver las entidades dentro. |
Solicitar cuerpo
El cuerpo de la solicitud especifica las entidades a resolver. Cada ID de entidad corresponde al tipo de entidad en el mismo índice.
{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}
{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}
| Propiedad | Tipo de datos | Descripción |
|---|---|---|
entityIds (obligatorio) | Matriz de Strings | Los identificadores únicos de las entidades del directorio que se van a resolver. |
entityTypes (obligatorio) | Matriz de Strings | Los tipos correspondientes a cada ID de entidad. Valores válidos: User, Group, Application. Debe tener la misma longitud que entityIds. |
Respuesta
200 OK
Devuelve un diccionario que asigna cada identificador de entidad a su entidad de directorio resuelta. Las entidades que no se pudieron resolver se devuelven como null.
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"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"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"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"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}
400 Bad Request
Se devuelve cuando entityIds y entityTypes tienen longitudes diferentes, o cuando faltan los parámetros necesarios.
Solicitud de ejemplo
Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.
- Su
{baseURL}es: https://cloud.uipath.com/{organizationName}/identity_ - Tu
{access_token}es:1234(para consideraciones de longitud) - El
{partitionGlobalId}es:3fa85f64-5717-4562-b3fc-2c963f66afa6 - Desea resolver un usuario y un grupo en una llamada.
La llamada debe parecerse al siguiente ejemplo (cURL):
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolve/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolve/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}'
Aquí está el body de respuesta de una llamada correcta:
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"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"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"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"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}