Search Directory

Searches the directory for entities (users, groups, or applications) matching a prefix string, based on the organization ID.

API 端点

GET {accessURL}/{organizationName}/identity_/api/Directory/Search/{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.Directory

请求标头

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

备注：

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

路径参数

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

查询参数

查询参数	数据类型	描述
startsWith (必填)	字符串	The prefix string to search for. Results will match entities whose name, email, or display name starts with this value.
entityType (可选)	字符串	The type of directory entity to search for. Valid values: User, Group, Application. Cannot be used together with sourceFilter.
sourceFilter (可选)	Array of strings	Filters results by source. Valid values: LocalUsers, DirectoryUsers, LocalGroups, DirectoryGroups, RobotAccounts, Applications. Cannot be used together with entityType.
scope (可选)	字符串	Optional scope used for entities in active directory.

响应

200 OK

Returns a list of directory entities matching the search criteria.

[
    {
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "identityName": "[e-mail]",
        "displayName": "John Doe",
        "email": "[e-mail]",
        "type": "User",
        "objectType": "DirectoryUser"
    },
    {
        "source": "aad",
        "identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "identityName": "Engineering Team",
        "displayName": "Engineering Team",
        "email": null,
        "type": "Group",
        "objectType": "DirectoryGroup"
    }
]

400 Bad Request

Returned when both entityType and sourceFilter are provided, 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 search for users whose name starts with "john".

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

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/Search/3fa85f64-5717-4562-b3fc-2c963f66afa6?startsWith=john&entityType=User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

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

[
    {
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "identityName": "[e-mail]",
        "displayName": "John Doe",
        "email": "[e-mail]",
        "type": "User",
        "objectType": "DirectoryUser"
    }
]