Query User Information by Username

Last Updated on : 2023-06-15 04:50:50

Query the detailed information about a specified user based on the username.

API address

GET: /v1.2/iot-02/users/{user_name}

Request parameter

Parameter name	Type	IN	Required	Description
user_name	String	uri	true	The username.

Return parameter

Parameter name	Type	Description
result	QueryUserResponse	The returned result.

Description of result

Parameter name	Type	Description
reg_origin	Integer	The source of registration.
user_name	String	The username.
creator	String	The creator.
account_type	Integer	The account type.
user_id	String	Tuya user ID.
mobile	String	The mobile phone number.
email	String	The email address.
tenant_code	String	The code of a specified tenant.
country_code	String	The country code.
user_nick_name	String	The nickname of a specified user.

Request example

GET: /v1.0/iot-02/users/abcd

{
  "user_name": "134****5102"
}

Return example

{
    "result": {
        "account_type": 3,
        "creator": "kun****min",
        "user_name": "134****5102",
        "mobile": "134****5102",
        "user_nick_name": "abc",
        "country_code": "86",
        "user_id": "bay1****O7eE",
        "email": ""
    },
    "t": 1641796815202,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify User Information

Next DocQuery User Information on Pages