文档首页/ 医疗智能体 EIHealth/ API参考/ API（医疗智能体平台）/ 系统管理/ 用户管理/ 获取用户列表
更新时间：2024-07-12 GMT+08:00
查看PDF
分享

获取用户列表

功能介绍

获取用户列表

URI

GET /v1/{project_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

华为云项目ID，您可以从获取项目ID中获取。

最小长度：1

最大长度：128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

最小长度：1

最大长度：32768

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

用户数

users

Array of GetUserRsp objects

用户信息列表
表4 GetUserRsp

参数

参数类型

描述

id

String

用户id

name

String

用户名，长度4~31之间，首位不能为数字，特殊字符只能包含下划线“_”、中划线“-”和空格

role

String

角色类型：管理员(ADMIN)、操作者(OPERATOR)

status

String

状态

email

String

用户邮箱，需符合邮箱格式

phone

String

用户手机号，纯数字，长度小于等于32位。必须与国家码同时存在。

areacode

String

国家码。中国大陆为“0086”

is_domain_owner

Boolean

是否domain用户

create_time

String

用户创建时间，UTC时间

pwd_status

Boolean

是否需要修改密码

update_time

String

更新时间，UTC时间

source

String

来源，PLATFORM或者IAM

请求示例

无

响应示例

状态码： 200

OK

{
  "count" : 1,
  "users" : [ {
    "id" : "7116d09f88fa41908676fdd4b039...",
    "name" : "user",
    "role" : "ADMIN",
    "status" : "ACTIVE",
    "email" : "example@huawei.com",
    "phone" : "12345678910",
    "areacode" : "0086",
    "is_domain_owner" : true,
    "create_time" : "2021-01-15T02:45:38Z",
    "pwd_status" : true,
    "update_time" : "2021-01-15T02:45:38Z",
    "source" : "PLATFORM"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 用户管理

相关文档