Resolve Directory Entity by Name

Resolves a single directory entity by its name and type, based on the organization ID.

API 端点

POST {accessURL}/{organizationName}/identity_/api/Directory/ResolveByName/{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'

备注：

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

路径参数

路径参数	数据类型	描述
partitionGlobalId (必填)	String (GUID)	The ID of the organization to resolve the entity within.

请求正文

The request body specifies the entity to resolve by name.

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

属性	数据类型	描述
entityName (必填)	字符串	The name of the directory entity (e.g., email address for users, group name for groups).
entityType (必填)	字符串	The type of directory entity. Valid values: User, Group, Application.

响应

200 OK

Returns the full directory entity. The response shape is the same as the Resolve endpoint (varies by entity type).

404 未找到

Returned when the entity or partition cannot be found.

请求示例

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

• 您的{baseURL}为: https://cloud.uipath.com/{organizationName}/identity
• 您的 {access_token} 为：1234（出于长度考虑）。
• {partitionGlobalId} 为：3fa85f64-5717-4562-b3fc-2c963f66afa6
• You want to resolve a user by their email [e-mail].

调用应类似于以下示例 (cURL)：

curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/ResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityName": "[e-mail]",
    "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"
}