查询用户信息

更新时间：2023-06-21 07:13:08

本文介绍查询用户信息的 API。

接口描述

支持通过用户名或者用户列表页面等信息，查询单个或多个用户的信息。

接口地址

GET: /v1.0/iot-03/users

请求参数

参数名	类型	参数位置	是否必填	说明
user_condition_req	QueryUserConditionReq		false	查询用户请求

user_condition_req 说明

参数名	类型	是否必填	说明
name	String	false	用户名
mobile	String	false	手机号
email	String	false	邮箱
user_no	String	false	工号
org_id	String	false	组织 ID
last_row_key	String	false	每页最后一条数据设备 ID
page_size	Integer	false	分页大小

返回参数

参数名	类型	说明
result	CursorPage

result 说明

参数名	类型	说明
has_more	Boolean	是否提供更多信息
list	List
last_row_key	String	每页最后一条数据设备 ID

list 说明

参数名	类型	说明
id	String	用户 ID
external_id	String	外部 ID
user_no	String	学号/工号
user_account	String	用户名
name	String	姓名
mobile	String	手机
email	String	邮箱
gender	String	性别
status	Integer	状态，0：禁用；1：启用
start_time	Long	开始时间
end_time	Long	结束时间

请求示例

GET: /v1.0/iot-03/users?page_size=20&name=tset****

返回示例

{
    "result": {
        "last_row_key": "140261201717238****",
        "list": [
            {
                "gender": "1",
                "end_time": 1621183690538,
                "mobile": "1667677****",
                "external_id": "322****",
                "user_no": "2013****",
                "start_time": 1621183630538,
                "name": "jinyunt****",
                "user_account": "1112323****",
                "id": "bsh1621492009764I****",
                "email": "123****@tuya.com",
                "status": 1
            }
        ],
        "has_more": false
    },
    "t": 1623772488275,
    "success": true
}

错误码

参考错误码。

上一篇用户绑定组织

下一篇校园办公组织管理