查询用户列表 - ListUsers
功能介绍
查询用户列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v1/csms/users
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
org_id |
否 |
String |
组织id，为空时查询所有用户。 |
|
offset |
是 |
Integer |
第几页。最小值：0 |
|
limit |
是 |
Integer |
每页多少条。最小值：10。最大值：100 |
|
user_info |
否 |
String |
最长64位，用户名，支持模糊查询 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Long |
用户总数。 |
|
users |
Array of UsersDetailsResult objects |
用户列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
用户id。 |
|
org_id |
String |
用户所属组织。 |
|
user_name |
String |
用户名。 |
|
name |
String |
姓名。 |
|
mobile |
String |
手机号。 |
|
|
String |
邮箱。 |
|
pwd_must_modify |
Boolean |
首次登录是否强制修改密码。 |
|
pwd_change_at |
String |
密码修改时间。 |
|
created_at |
String |
创建时间。 |
|
updated_at |
String |
最后一次修改时间。 |
|
disabled |
String |
是否禁用。 |
|
grade |
String |
可信等级。 |
|
locked |
String |
是否锁定。 |
|
extension |
String |
自定义扩展属性。 |
|
user_org_relation_list |
Array of UserOrgRelationListResult objects |
用户组织关系集合。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误编号。 |
|
error_msg |
String |
错误详情。 |
请求示例
查询用户列表，查询前10条所有组织下的用户列表
/api/v1/tenant/users?org_id=&offset=0&limit=10
响应示例
状态码：200
请求成功。
{
"total" : 1,
"users" : [ {
"extension" : { },
"user_name" : "zhangsan",
"mobile" : "12345678901",
"created_at" : "2022-03-31 16:46:02.964",
"pwd_must_modify" : false,
"updated_at" : "2022-03-31 16:48:44.073",
"user_id" : "20220331164602949-904C-D475B60AE",
"org_id" : "20220331135144180-0FA5-EE3B69068",
"grade" : 1,
"name" : "zhangsan",
"disabled" : false,
"pwd_change_at" : "2022-03-31 16:47:51.481",
"locked" : false,
"user_org_relation_list" : [ {
"org_id" : "20220331135144180-0FA5-EE3B69068",
"relation_type" : 1
}, {
"org_id" : "20220415103506608-AF59-5CC9081B9",
"relation_type" : 0
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
请求失败。 |
错误码
请参见错误码。
