客户身份(CIAM)
查询用户列表
# 请求说明
GET https://{your_domain}/api/v2/tenant/users
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| Authorization | 授权 | 是 | String | 格式：Bearer {access_token} |
| Content-Type | 内容类型 | 是 | String | 固定值：application/json; charset=utf-8 |
# 请求示例
GET https://{your_domain}/api/v2/tenant/users?offset=0&limit=10
# 请求参数
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| offset | 分页页码 | 是 | Number | 从第0页开始 |
| limit | 每页数量 | 是 | Number | 每页数量在10-100之间 |
| updated_at_greater | 更新时间大于 | 否 | String | 根据更新时间过滤，更新时间在此之后的才会返回，格式为 yyyy-MM-dd HH:mm:ss |
| updated_at_less | 更新时间小于 | 否 | String | 根据更新时间过滤，更新时间在此之前的才会返回，格式为 yyyy-MM-dd HH:mm:ss |
# 返回值示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"total":2,
"users":[
{
"user_name":"zhangsan",
"user_id":"20220126153857263-A04D-60E0D446C",
"name":"张三",
"mobile":"15200000000",
"email":"15200000000@qq.com",
"pwd_change_at":"2022-02-15 12:23:23",
"created_at":"2022-02-10 12:23:23",
"updated_at":"2022-02-15 12:23:23",
"disabled":false,
"attr_gender":"male",
"attr_birthday":"2022-02-17",
"attr_nick_name":"张三",
"mailing_address":"湖北省武汉市",
"zip_code":"430000",
"first_name":"",
"middle_name":"",
"last_name":"",
"industry":"事业单位",
"external_id":"12345678741d29069abcdef089d4q87sk12",
"usr_auth_times":"4",
"usr_last_login":"2022-02-17 13:00:25",
"extension": {
"age":"28"
},
"head_img": "https://........"
},
{
"user_name":"zhangsan",
"user_id":"20220126153857263-A04D-60E0D446D",
"name":"张三",
"mobile":"15200000000",
"email":"15200000000@qq.com",
"pwd_change_at":"2022-02-15 12:23:23",
"created_at":"2022-02-10 12:23:23",
"updated_at":"2022-02-15 12:23:23",
"disabled":false,
"attr_gender":"male",
"attr_birthday":"2022-02-17",
"attr_nick_name":"张三",
"mailing_address":"湖北省武汉市",
"zip_code":"430000",
"first_name":"",
"middle_name":"",
"last_name":"",
"industry":"事业单位",
"external_id":"12345678741d29069abcdef089d4q87sk16",
"usr_auth_times":"4",
"usr_last_login":"2022-02-17 13:00:25",
"extension": {
"age":"28"
},
"head_img": "https://........"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# 返回参数
| 参数名 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| user_name | 用户名 | String | |
| user_id | 用户ID | String | |
| name | 姓名 | String | |
| mobile | 手机号 | String | |
| 邮箱 | String | ||
| pwd_change_at | 密码修改时间 | String | |
| created_at | 用户创建时间 | String | |
| updated_at | 用户修改时间 | String | |
| disabled | 是否已禁用 | String | |
| attr_gender | 性别 | String | "unknow":保密 "male":男 "female":女 |
| attr_birthday | 生日 | String | 格式为： yyyy-mm-dd |
| attr_nick_name | 昵称 | String | |
| mailing_address | 邮寄地址 | String | |
| zip_code | 邮政编码 | String | |
| first_name | 名字 | String | |
| middle_name | 中间名 | String | |
| last_name | 姓氏 | String | |
| industry | 所属行业 | String | |
| external_id | 外部ID | String | |
| usr_auth_times | 登录次数 | Number | |
| usr_last_login | 最后登录时间 | String | |
| extension | 扩展属性 | JSONObject | |
| head_img | 用户头像url | String |
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | IDAAS.TENANT.PAGE.0001 | The number of pages does not meet the verification rules | 请重新输入每页数量 |
| 每页数量不符合校验规则 |