更新时间:2026-08-17 GMT+08:00
分享

查询用户列表 - ListUsersDetail

功能介绍

查询用户列表接口用于获取系统中用户的列表信息。该接口适用于以下场景:当需要查看系统中所有用户或根据特定条件筛选用户时,管理员或系统可以通过此接口查询用户列表。使用该接口的前提条件是用户已存在且查询者具有相应的权限。查询操作完成后,接口将返回符合条件的用户列表;若系统中无用户或查询者无权限操作,接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/workspaces/users/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID。获取方法请参见获取项目ID和名称

约束限制:1 - 64字符,字母、数字和中划线。

取值范围:不涉及。

默认取值:不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

users

Array of UserName objects

参数解释:授权对象列表。

表4 UserName

参数

参数类型

描述

userName

String

参数解释:授权对象名称。

取值范围:不涉及。

请求示例

响应示例

状态码:200

查询用户角色信息

{
  "users" : [ {
    "userName" : "app"
  }, {
    "userName" : "zx-test"
  } ]
}

状态码

状态码

描述

200

查询用户角色信息

错误码

请参见错误码

相关文档