Query Role Permission Set

Last Updated on : 2023-06-15 05:02:30

Query a set of permissions based on the list of role codes.

API address

GET: /v1.0/iot-02/roles-permissions

Request parameter

Parameter name	Type	IN	Required	Description
request	RolePermissionQueryRequest	query	true	The request of querying role permissions.

Description of request

Parameter name	Type	IN	Required	Description
role_codes	String		true	The list of role IDs, separated with commas (,).

Return parameter

Parameter name	Type	Description
result	List	The returned result of the relationship between roles and permissions.

Description of result

Parameter name	Type	Description
role_code	String	The identifier of a specified role.
permissions	List	The list of permissions.

Description of permissions

Parameter name	Type	Description
permission_code	String	The identifier of a permission.
permission_name	String	The name of a specified permission.
permission_type	Integer	The type of permission. Valid values: `1`: API `2`: menu `3`: button `4`: data `5`: combination
parent_code	String	The identifier of a parent permission.
order	Integer	The order that the items are displayed.
remark	String	The remarks.

Request example

GET: /v1.0/iot-02/roles-permissions?role_codes=roleCodegcnI, roleCodegdkj

Return example

{
    "tid": "51a630e5948811ec82481264f1be8bd1",
    "result": [
        {
            "role_code": "roleCodegcnI",
            "permissions": [
                {
                    "remark": "Remarks about modifications",
                    "permission_code": "permissionCodepHhD",
                    "permission_name": "namepermissionCodepHhD",
                    "permission_type": 4,
                    "order": 3
                }
            ]
        }
    ],
    "t": 1645607374866,
    "success": true
}

Error code

For more information, see error code.

Prev DocCheck Role Permissions

Next DocEdit Role Permissions