Query User IDs with Role

Last Updated on : 2023-07-06 09:13:56download

Query the list of user IDs that have a specified role. Pagination is supported.

API address

GET: /v1.0/iot-02/{role_code}/uids

Request parameter

Parameter nameTypeINRequiredDescription
role_codeStringuritrueThe identifier of a specified role.
page_noIntegerqueryfalseThe page number. Default value: 1.
page_noIntegerqueryfalseThe number of items returned on each page. Default value: 20. Maximum value: 200.

Return parameter

Parameter nameTypeDescription
resultPageResponseThe returned result.

Description of result

Parameter nameTypeDescription
totalIntegerThe total number.
listListThe list of user IDs.
has_moreBooleanSpecifies whether there is a next page.

Request example

GET: /v1.0/iot-02/roleCodeb7NS/uids?page_no=1&page_size=2

Return example

{
    "result": {
        "list": [
            "bsh1645012345****"
        ],
        "total": 1,
        "has_more": false
    }
}

Error code

For more information, see error code.