test-cloud
latest
false
- 入门指南
- 身份验证
- 作用域和权限
- 平台管理 API
- Identity Server 的 API 速率限制
- 检索分区全局 ID 以供 API 使用
- 警示
- Search Directory
- Resolve Directory Entity
- Resolve Directory Entity by Name
- Bulk Resolve Directory Entities
- Bulk Resolve Directory Entities by Name
Test Cloud API 指南
上次更新日期 2026年5月5日
Resolves multiple directory entities by their names in a single request, based on the organization ID. All entities in the request must be of the same type.
API 端点
POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolveByName/{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 entity names to resolve. Unlike BulkResolve, all entities must be of the same type.
{
"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
}
| 属性 | 数据类型 | 描述 |
|---|---|---|
entityNames (必填) | Array of strings | The names of the directory entities to resolve (e.g., email addresses for users, group names for groups). |
entityType (必填) | 字符串 | The type of all entities in the request. Valid values: User, Group, Application. |
scope (可选) | 字符串 | Optional scope for active directory entities. |
响应
200 OK
Returns a dictionary mapping each entity name to its resolved directory entity. Entities that could not be resolved are returned as 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
Returned when required parameters are missing or invalid.
请求示例
假设您收集了构建 API 调用所需的所有信息。
- 您的
{baseURL}为: https://cloud.uipath.com/{organizationName}/identity - 您的
{access_token}为：1234（出于长度考虑）。 {partitionGlobalId}为：3fa85f64-5717-4562-b3fc-2c963f66afa6- You want to resolve two users by their email addresses.
调用应类似于以下示例 (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"
}'
以下是成功调用的响应正文：
{
"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
}