v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Roles

List dependent roles

Retrieves all roles that directly extend the specified base role through inheritance. Use this endpoint to understand the role hierarchy and identify which roles inherit permissions from a particular base role. Provide the base role name as a path parameter, and the response will include all dependent roles with their metadata and permission information. This operation is useful for auditing role inheritance relationships, understanding the impact of changes to base roles, or managing role hierarchies effectively. Returns a list of dependent role objects including their names, display names, descriptions, and permission details.

get/api/v1/roles/{role_name}/dependents

Path parameters

role_namestring required

Name of the base role

Response

Successfully retrieved dependent roles. Returns a list of all roles that extend the specified base role, including their metadata and permission information.

Example response

{
  "roles": [
    {
      "default_creator": true,
      "default_member": true,
      "dependent_roles_count": 3,
      "description": "Can create, edit, and publish content but cannot delete or manage users",
      "display_name": "Content Editor",
      "extends": "admin_role",
      "id": "role_1234abcd5678efgh",
      "is_org_role": true,
      "name": "content_editor",
      "permissions": [
        {
          "description": "Read Content",
          "name": "read:content",
          "role_name": "admin_role"
        },
        {
          "description": "Write Content",
          "name": "write:content",
          "role_name": "editor_role"
        }
      ]
    }
  ]
}