- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
API endpoint for resolving multiple directory entities by their unique identifiers and types in a single request within an organization.
Resolves multiple directory entities by their unique identifiers and types in a single request, based on the organization ID.
API Endpoint
POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolve/{partitionGlobalId}
Replace {accessURL} in all endpoint paths with the base URL for your cloud platform:
| Cloud platform | Access URL |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud Public Sector | https://govcloud.uipath.us/ |
| Test Cloud Dedicated | https://{customURL}.dedicated.uipath.com/ |
Scopes
Requires the following scopes:
- PM.Directory
Request Headers
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
To obtain the {access_token}, make sure to authenticate through one of the methods described here.
Path Parameters
| Path param | Data type | Description |
|---|---|---|
partitionGlobalId (required) | String (GUID) | The ID of the organization to resolve the entities within. |
Request Body
The request body specifies the entities to resolve. Each entity ID corresponds to the entity type at the same index.
{
"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"
]
}
| Property | Data type | Description |
|---|---|---|
entityIds (required) | Array of strings | The unique identifiers of the directory entities to resolve. |
entityTypes (required) | Array of strings | The types corresponding to each entity ID. Valid values: User, Group, Application. Must be the same length as entityIds. |
Responses
200 OK
Returns a dictionary mapping each entity identifier to its resolved directory entity. Entities that could not be resolved are returned as null.
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "[email protected]",
"email": "[email protected]",
"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": "[email protected]",
"email": "[email protected]",
"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
Returned when entityIds and entityTypes have different lengths, or when required parameters are missing.
Example Request
Let's say you gathered all the information needed to build the API call.
- Your
{baseURL}is: https://cloud.uipath.com/{organizationName}/identity_ - Your
{access_token}is:1234(for length considerations). - The
{partitionGlobalId}is:3fa85f64-5717-4562-b3fc-2c963f66afa6 - You want to resolve a user and a group in one call.
The call should resemble the following example (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"
]
}'
Here's the response body for a successful call:
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "[email protected]",
"email": "[email protected]",
"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": "[email protected]",
"email": "[email protected]",
"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"
}
}