查询用户列表_云效(Apsara Devops)-阿里云帮助中心

通过 OpenAPI 查询用户列表。

适用版本

企业专属版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。

产品	资源	所需权限
基础服务	用户	只读

请求语法

GET https://{domain}/oapi/v1/platform/users

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
filter	string	query	否	查询信息，支持用户名、登录名、邮箱、手机号等信息的模糊搜索。
status	string	query	否	用户状态。
deptId	string	query	否	所属部门。	99d1****6124
page	integer	query	否	当前页，默认1。	1
perPage	integer	query	否	每页数据条数，默认100。	100

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/platform/users?filter={filter}&status={status}&deptId={deptId}&page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
email	string	邮箱。	test****@example.com
id	string	用户 ID。	99d1****6124
lastOrganization	string	上次登录组织。	99d1****6124
name	string	显示名称。	示例用户名
nickName	string	昵称。	示例昵称
staffId	string	工号。	123****
sysDeptIds	array[string]	所属部门。	[99d1****6124]
username	string	登录账号名。	demo**username

返回示例

[
    {
        "email": "test****@example.com",
        "id": "99d1****6124",
        "lastOrganization": "99d1****6124",
        "name": "示例用户名",
        "nickName": "示例昵称",
        "staffId": "123****",
        "sysDeptIds": [99d1****6124],
        "username": "demo**username"
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。	2
x-page	当前页。	1
x-per-page	每页大小。	20
x-prev-page	前一页。	0
x-request-id	请求 ID。	37294673-00CA-5B8B-914F-A8B35511E90A
x-total	总数。	10
x-total-pages	总分页数。	1

错误码

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