Query User List

Last Updated on : 2023-10-09 08:08:34download

Based on the permission ID, query the list of users that are linked with the specified permission.

API address

GET: /v2.0/cloud/iam/user/permission/{permission_id}

Request parameter

Parameter name	Type	IN	Required	Description
permission_id	Long	uri	true	The ID of the specified permission.
last_row_key	Long	query	false	The starting ID of the query.
page_size	Integer	query	false	The number of items returned on each page.

Return parameter

Parameter name	Type	Description
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
error_code	String	The error code. For more information, see the error codes.
error_msg	String	The message that is returned if the request fails. It is empty if the request is successful.
result	QueryUserListByPermissionRes	The returned result.

Description of result

Parameter name	Type	Description
permission_id	Long	The ID of the specified permission.
permission_name	String	The name of the specified permission.
permission_desc	String	The description of the specified permission.
user_ids	List	The list of user IDs (UIDs).
last_row_key	Long	The starting ID of the query.
page_size	Integer	The number of items returned on each page.
total	Integer	The total number of returned entries.

Description of user_ids

Parameter name	Type	Description
user_id	String	The user ID.
gmt_create	Long	The creation time.

Request example

GET: /v2.0/cloud/iam/user/permission/123?last_row_key=0&page_size=100

Return example

{
    "tid": "195bceee56b411ee801ef25dabf95fef",
    "result": {
        "last_row_key": 181044,
        "user_ids": [
            {
                "gmt_create": 1695104201,
                "user_id": "uid123"
            }
        ],
        "permission_id": 232371810,
        "permission_name": "Permission name",
        "total": 15,
        "permission_desc": "Description",
        "page_size": 10
    },
    "t": 1695104201504,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Permission Data

Next DocCreate Permission