解析目录实体

根据组织 ID，通过唯一标识符和类型解析单个目录实体。

API 端点

POST {accessURL}/{organizationName}/identity_/api/Directory/Resolve/{partitionGlobalId}

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Automation Cloud	https://cloud.uipath.com/
Automation Cloud 公共部门	https://govcloud.uipath.us/
Automation Cloud 专用	https://{customURL}.dedicated.uipath.com/

作用域

需要以下作用域：

• PM.目录

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

备注：

要获取{access_token} ，请确保通过此处描述的其中一种方法进行身份验证。

路径参数

路径参数	数据类型	描述
partitionGlobalId (必填)	字符串 (GUID)	要解析其中实体的组织 ID。

请求正文

请求正文指定要解析的实体。

{
    "entityId": "string",
    "entityType": "User"
}

属性	数据类型	描述
entityId (必填)	字符串	目录实体的唯一标识符。
entityType (必填)	字符串	目录实体的类型。有效值： User 、 Group和Application 。

响应

200 OK

返回完整目录实体。响应形状因实体类型而异。

用户响应

{
    "objectType": "DirectoryUser",
    "source": "aad",
    "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "[e-mail]",
    "email": "[e-mail]",
    "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": "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": "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 未找到

找不到实体或分区时返回。

请求示例

假设您收集了构建 API 调用所需的所有信息。

• 您的{baseURL}为: https://cloud.uipath.com/{organizationName}/identity
• 您的 {access_token} 为：1234（出于长度考虑）。
• {partitionGlobalId} 为：3fa85f64-5717-4562-b3fc-2c963f66afa6
• 要解析 ID 为aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890用户。

调用应类似于以下示例 (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"
}'

以下是成功调用的响应正文：

{
    "objectType": "DirectoryUser",
    "source": "aad",
    "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "[e-mail]",
    "email": "[e-mail]",
    "displayName": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "jobTitle": "Software Engineer",
    "companyName": "Contoso",
    "city": "Seattle",
    "department": "Engineering",
    "isActive": true,
    "creationTime": "2025-01-15T10:30:00Z"
}