test-cloud
latest
false
Test Cloud API guide
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
Resolve Directory Entity API endpoint for looking up a single directory entity by unique identifier and type using the organization ID in Test Cloud.
Resolves a single directory entity by its unique identifier and type, based on the organization ID.
API Endpoint
POST {accessURL}/{organizationName}/identity_/api/Directory/Resolve/{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'
Note:
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 entity within. |
Request Body
The request body specifies the entity to resolve.
{
"entityId": "string",
"entityType": "User"
}
{
"entityId": "string",
"entityType": "User"
}
| Property | Data type | Description |
|---|---|---|
entityId (required) | String | The unique identifier of the directory entity. |
entityType (required) | String | The type of directory entity. Valid values: User, Group, Application. |
Responses
200 OK
Returns the full directory entity. The response shape varies based on entity type.
User response
{
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "[email protected]",
"email": "[email protected]",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}
{
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "[email protected]",
"email": "[email protected]",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}
Group response
{
"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"
}
{
"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"
}
Application response
{
"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"
}
{
"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 Not Found
Returned when the entity or partition cannot be found.
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 with ID
aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890.
The call should resemble the following example (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"
}'
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"
}'
Here's the response body for a successful call:
{
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "[email protected]",
"email": "[email protected]",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}
{
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "[email protected]",
"email": "[email protected]",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}