Realm Roles

Update a realm role

Updates the role's name or description. Renaming a role does not affect existing assignments.

Required scope: realm-roles:write

patch/clusters/{cluster_id}/realms/{realm_name}/roles/{role_name}

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm_name}/roles/{role_name}
  • 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
role_namestring required

Role name.

Example:admin

Headers

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

Request body

namestring

Role name.

descriptionstring

Example request

{
  "description": "Read-only access"
}

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.