Realm Roles

List realm roles

Returns the roles defined in the specified realm.

Required scope: realm-roles:read

get/clusters/{cluster_id}/realms/{realm_name}/roles

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm_name}/roles
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required
realm_namestring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

Example:customer-portal

Headers

API-Version'2026-06-01.beta' required

Response

The request has succeeded.

namestring required

Role name.

descriptionstring nullable

Human-friendly role description, when available.

compositeboolean

Whether this role is composed from other roles.

client_roleboolean

Whether this is a client-scoped role rather than a realm-scoped role.

Example response

[
  {
    "name": "admin",
    "description": "Administrative access",
    "composite": false,
    "client_role": false
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.