搜索目录

根据组织 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.目录

请求标头

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

备注：

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

路径参数

路径参数	数据类型	描述
partitionGlobalId (必填)	字符串 (GUID)	要在其中搜索的组织的 ID。

查询参数

查询参数	数据类型	描述
startsWith (必填)	字符串	要搜索的前缀字符串。结果将匹配名称、电子邮件或显示名称以此值开头的实体。
entityType (可选)	字符串	要搜索的目录实体的类型。有效值： User 、 Group和Application 。不能与sourceFilter一起使用。
sourceFilter (可选)	字符串数组	按来源筛选结果。有效值： LocalUsers 、 DirectoryUsers 、 LocalGroups 、 DirectoryGroups 、 RobotAccounts 、 Applications 。不能与entityType一起使用。
scope (可选)	字符串	用于 Active Directory 中的实体的可选作用域。

响应

200 OK

返回与搜索条件匹配的目录实体的列表。

[
    {
        "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

同时提供了entityType和sourceFilter或缺少必要参数时返回。

请求示例

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

• 您的{baseURL}为: https://cloud.uipath.com/{organizationName}/identity
• 您的 {access_token} 为：1234（出于长度考虑）。
• {partitionGlobalId} 为：3fa85f64-5717-4562-b3fc-2c963f66afa6
• 您要搜索名称以“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"
    }
]