文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 通行证管理/ 获取用户列表(包含已分配、未激活、IAM全用户列表)
更新时间:2024-08-05 GMT+08:00
分享

获取用户列表(包含已分配、未激活、IAM全用户列表)

功能介绍

获取用户列表(包含已分配、未激活、IAM全用户列表)。

URI

GET /v1/{project_id}/quota-users/all

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参考获取项目ID

最小长度:0

最大长度:128

表2 Query参数

参数

是否必选

参数类型

描述

account_name

String

用户名(模糊查询)。

最小长度:0

最大长度:512

sys_role_list

Array

系统角色

  • 0未激活;
  • 1通用用户;
  • 2只读用户。

数组长度:0 - 3

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

最小长度:0

最大长度:8192

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of 表5 objects

-

表5 UserQuotaVo

参数

参数类型

描述

user_id

String

用户id。

最小长度:0

最大长度:128

account_name

String

用户名称。

最小长度:0

最大长度:512

user_type

String

用户类型,:IAM|SELF-BUILT|DEFAULT

最小长度:0

最大长度:128

sys_role

Integer

用户角色:

  • 0未激活;
  • 1通用角色;
  • 2只读用户。

最小值:0

最大值:128

effective_time

Long

生效时间戳。

最小值:0

最大值:9223372036854775807

请求示例

GET https://{endpoint}/v1/{project_id}/quota-users/all?account_name=&sys_role_list=

响应示例

状态码

状态码

描述

200

获取全量用户列表成功。

错误码

请参见错误码

相关文档