搜索成员列表_通义灵码_智能编码助手_智能编码助手通义灵码(Lingma)-阿里云帮助中心

通过 OpenAPI 搜索成员列表。

适用版本

企业专属版、企业标准版

服务接入点

获取服务接入点，替换 API 请求语法中的 {domain} 。

授权信息

产品	资源	所需权限
组织管理	组织成员	只读

请求语法

POST https://{domain}/oapi/v1/platform/organizations/{organizationId}/members:search

请求说明	企业标准版搜索成员列表 `curl -X 'POST' \ 'https://openapi-rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1**71d4/members:search' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh30fbG_35af0484' \ --data ' { "deptIds": ["99d16124"], "includeChildren": false, "nextToken": "", "query": "phw", "roleIds": ["99d16124"], "statuses": ["ENABLED"] }'` 企业专属版搜索成员列表 `curl -X 'POST' \ 'https://test-domain-.rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1*71d4/members:search' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh30fbG_35af0484' \ --data ' { "deptIds": ["99d16124"], "includeChildren": false, "nextToken": "", "page": 1, "perPage": 100, "query": "phw", "roleIds": ["99d1**6124"], "statuses": ["ENABLED"] }'`
x-yunxiao-token `string` （必选）个人访问令牌。您可参考个人访问令牌获取。示例：pt-0fh3**0fbG_35af**0484。
请求参数
organizationId `string` （必选）组织 ID。您可前往组织管理后台的基本信息页面获取组织ID（organizationId）。
deptIds `array[string]`（可选）所属部门列表，可以为空。
includeChildren `boolean`（可选）默认值为 `false` 【仅专属版适用】是否包含子部门，true：包含，false：不包含。当 deptIds 为空时，该字段无意义。
nextToken `string`（可选）
page `integer`（可选）默认值为`1` 【仅专属版适用】当前页。
perPage `integer`（可选）默认值为`100` 【仅专属版适用】每页数据条数，取值范围：`[1，100]`。
query `string`（可选）查询参数。
roleIds `array[string]`（可选）角色列表，可以为空。
statuses `array[string]`（可选）默认值为 `ENABLED` 成员状态过滤，默认返回状态为 ENABLED 的成员。可选值：`ENABLED`，`DISABLED`，`UNDELETED`，`DELETED`，`NORMAL_USING`，`UNVISITED`。 `ENABLED=NORMAL_USING+UNVISITED`；`UNDELETED=ENABLED+DISABLED`。

返回参数	返回示例 `[ { "deptIds": ["99d1**6124"], "id": "99d16124", "joined": "2023-08-31T03:59:16.201Z", "name": "示例名", "organizationId": "99d16124", "roleIds": ["99d16124"], "status": "ENABLED", "userId": "99d1**6124", "visited": "2023-08-31T03:59:16.201Z" } ]`
deptIds `array[string]` 所属组织部门列表。
id `string` 成员 ID。
joined`string` 加入时间，等于数据库的创建时间。
name `string` 成员名。
organizationId`string` 组织 ID。
roleIds`array[string]` 角色信息。
status`string` 成员状态。可选值：`ENABLED`,`DISABLED`,`UNDELETEDDELETED`,`NORMAL_USING`,`UNVISITED`。
userId`string` 用户 ID。
visited`string` 最后访问时间。

响应头

参数	描述	示例值
x-next-page	【仅专属版适用】下一页。	1
x-page	【仅专属版适用】当前页。	2
x-per-page	【仅专属版适用】每页数据条数。	1
x-prev-page	【仅专属版适用】上一页。	2
x-total	【仅专属版适用】总数据量。	1
x-total-pages	【仅专属版适用】总分页数。	3

错误码

访问错误码中心查看 API 相关错误码。

服务接入点

授权信息

请求语法

请求说明

企业标准版

搜索成员列表

企业专属版

搜索成员列表

请求参数

返回参数

返回示例

响应头

错误码