v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Roles

List effective permissions for role

Retrieves the complete set of effective permissions for a role, including both directly assigned permissions and permissions inherited from base roles through the role hierarchy. Use this endpoint to understand the full scope of capabilities available to users assigned to a specific role. Provide the role name as a path parameter, and the response will include all permissions that apply to the role, accounting for inheritance relationships. This operation is essential for auditing role capabilities, understanding permission inheritance, or verifying the complete access scope before role assignment. Returns a comprehensive list of permission names representing the full set of effective permissions for the specified role.

get/api/v1/roles/{role_name}/permissions:all

Path parameters

role_namestring required

Name of the role

Response

Successfully retrieved effective permissions. Returns the complete list of all permissions that apply to the role, including both direct assignments and inherited permissions from base roles.

Example response

{
  "permissions": [
    {
      "is_scalekit_permission": true
    }
  ]
}