test-cloud
latest
false
- 入门指南
- 身份验证
- 作用域和权限
- 平台管理 API
Test Cloud API 指南
上次更新日期 2026年5月5日
Resolves multiple directory entities by their unique identifiers and types in a single request, based on the organization ID.
API 端点
POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolve/{partitionGlobalId}
将所有端点路径中的{accessURL}替换为您的云平台的基本 URL:
| Cloud Platform | 访问 URL |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud 公共部门版 | https://govcloud.uipath.us/ |
| Test Cloud 专用版 | https://{customURL}.dedicated.uipath.com/ |
作用域
需要以下作用域:
- PM.Directory
请求标头
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
备注:
要获取{access_token} ,请确保通过此处描述的其中一种方法进行身份验证。
路径参数
| 路径参数 | 数据类型 | 描述 |
|---|---|---|
partitionGlobalId (必填) | String (GUID) | The ID of the organization to resolve the entities within. |
请求正文
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"
]
}
| 属性 | 数据类型 | 描述 |
|---|---|---|
entityIds (必填) | Array of strings | The unique identifiers of the directory entities to resolve. |
entityTypes (必填) | Array of strings | The types corresponding to each entity ID. Valid values: User, Group, Application. Must be the same length as entityIds. |
响应
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": "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
Returned when entityIds and entityTypes have different lengths, or when required parameters are missing.
请求示例
假设您收集了构建 API 调用所需的所有信息。
- 您的
{baseURL}为: https://cloud.uipath.com/{organizationName}/identity - 您的
{access_token}为:1234(出于长度考虑)。 {partitionGlobalId}为:3fa85f64-5717-4562-b3fc-2c963f66afa6- You want to resolve a user and a group in one call.
调用应类似于以下示例 (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"
]
}'
以下是成功调用的响应正文:
{
"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"
}
}