查询用户列表 - ListUsers

功能介绍

查询用户列表。

接口约束

null

URI

GET /api/v2/tenant/users

表1 Query参数
参数	是否必选	参数类型	描述
org_id	是	String	组织id，为空时查询所有用户。
offset	是	Integer	第几页。
limit	是	Integer	每页多少条。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Authorization	是	String	认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
total	Long	用户总数。
users	Array of UsersDetailsResult objects	用户列表。

表4 UsersDetailsResult
参数	参数类型	描述
user_id	String	用户id。
org_id	String	用户所属组织。
user_name	String	用户名。
name	String	姓名。
mobile	String	手机号。
email	String	邮箱。
pwd_must_modify	Boolean	首次登录是否强制修改密码。
pwd_change_at	String	密码修改时间
created_at	String	创建时间。
updated_at	String	最后一次修改时间。
disabled	Boolean	是否禁用。
grade	Integer	可信等级。
locked	String	是否锁定。
extension	Object	自定义扩展属性。
user_org_relation_list	Array of UserOrgRelationListResult objects	用户组织关系集合。

表5 UserOrgRelationListResult
参数	参数类型	描述
org_id	String	组织id。
relation_type	String	关系类型。 0：归属。 1：挂靠。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误编号。
error_msg	String	错误详情。

请求示例

查询用户列表，查询前10条所有组织下的用户列表。

GET https://{domain_name}/api/v2/tenant/users?org_id=&offset=0&limit=10

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

响应示例

状态码：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
    } ]
  } ]
}