获取用户列表

权限

身份管理API是以应用维度授权的，在调用接口前需为不同的应用设置接口权限，详情请参考API权限。

权限代码	描述
user_all	用户管理接口的读写权限
user_read	用户管理接口的读权限
all	全部接口读写权限
read	所有读接口的权限

请求说明

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

请求头

参数名	中文名称	必须	类型	描述
Authorization	授权	是	String	格式：Bearer {access_token}
Content-Type	内容类型	是	String	固定值：application/json; charset=utf-8

请求示例

无

请求参数

参数名	中文名称	必须	类型	描述
org_id	组织ID	否	String	为空时查询所有用户
updated_at_greater	更新时间大于	否	String	根据更新时间过滤，更新时间在此之后的才会返回，格式为 yyyy-MM-dd HH:mm:ss
offset	分页页码	是	Int	从第0页开始
limit	每页数量	是	Int	每页数量在10-100之间

返回示例

正确示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
    "total": 1,
    "users": [
        {
            "user_id": "20220825141325371-4D03-81EF80243",
            "org_id": "20210529172248496-D329-5748DE918",
            "user_name": "cq04130007",
            "name": "cq04130007",
            "mobile": "+86-15204130007",
            "email": "15204130007@example.com",
            "first_name": "F",
            "middle_name": "M",
            "last_name": "L",
            "employee_id": "041300071",
            "external_id": "041300071",
            "attr_city": "武汉",
            "attr_nick_name": "cq04130007",
            "attr_area": "CN",
            "attr_gender": "male",
            "attr_work_place": "武汉",
            "attr_identity_type": "id_card",
            "attr_identity_number": "420100199911111111",
            "attr_manager_id": "20210601223953060-2AEC-D22770B77",
            "attr_birthday": "1993-08-25 00:00:00.000",
            "attr_user_type": "20211124152258971-9F54-3B43283CC",
            "attr_hire_date": "2022-08-01 00:00:00.000",
            "pwd_must_modify": false,
            "disabled": false,
            "locked": false,
            "grade": 1,
            "created_at": "2022-08-25 14:13:25.372",
            "updated_at": "2022-08-25 14:37:24.610",
            "last_login_ip": "120.46.143.105",
            "last_login_at": "2024-06-06 15:14:28.000",
            "user_org_relation_list": [
                {
                    "org_id": "20220221173529886-B8BB-9F404BCDE",
                    "relation_type": 0
                },
                {
                    "org_id": "20210529172248496-D329-5748DE918",
                    "relation_type": 1
                }
            ],
            "extension": {}
        }
    ]
}


错误示例：
HTTP/1.1 400 Bad Request
{
  "error_msg": "组织不存在",
  "error_code": "ORG.0001"
}

返回参数

参数名	中文名称	类型	描述
total	总数	Int
users	用户集合	List
--user_id	用户ID	String
--org_id	组织ID	String
--user_name	用户名	String
--name	姓名	String
--mobile	手机号	String
--email	邮箱	String
--first_name	名字	String
--middle_name	中间名	String
--last_name	姓氏	String
--employee_id	员工工号	String
--external_id	外部系统ID	String
--attr_gender	性别	String
--attr_birthday	生日	String
--attr_nick_name	昵称	String
--attr_identity_type	证件类型	String
--attr_identity_number	证件号码	String
--attr_area	国家或地区	String
--attr_city	城市	String
--attr_manager_id	直属上级	String	上级用户id
--attr_user_type	人员类型	String	类型id
--attr_hire_date	入职时间	String
--attr_work_place	工作地点	String
--pwd_must_modify	是否强制修改密码	Boolean
--created_at	用户创建时间	String
--updated_at	用户修改时间	String
--last_login_ip	最后登录IP	String
--last_login_at	最后登录时间	String
--disabled	是否已禁用	String
--grade	可信等级	Int
--locked	是否锁定	Boolean
--extension	扩展属性	JSONObject
--user_org_relation_list	用户机构关系集合	List
----job_id	关系ID	String
----org_id	组织ID	String
----relation_type	关系类型	int	1为归属 0为挂靠
--jobs	用户岗位集合	List	租户开启任职管理时返回
----job_id	岗位ID	String
----org_id	组织ID	String
----position_id	职位ID	String
----title_id	职务ID	String
----relation_type	岗位类型	String	1为主岗位 0为兼职兼岗

错误码

状态码	错误码	错误信息	处理措施
400	OAP.PAGE.0003	分页页码不符合校验规则	请检查入参分页页码是否正确
		The pagination page number does not meet the verification rules
400	OAP.PAGE.0004	每页数量不符合校验规则	请检查入参每页数量是否正确
		The number of pages does not meet the verification rules
400	OAP.PARAM.0004	参数[{0}]不符合校验规则	请检查入参是否符合校验规则
		Parameter [{0}] does not comply with validation rules
400	ORG.0001	组织不存在	请检查对应组织是否存在
		Organization does not exist