Realms

Update a realm

Partially updates realm settings.

Required scope: realms:write

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

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm_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

Headers

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

Request body

display_namestring
enabledboolean

Whether users can sign in to this realm.

ssl_required'external' | 'all' | 'none'

Keycloak SSL requirement. Maps directly to Keycloak's sslRequired realm setting.

registration_allowedboolean

Whether self-registration is open to anyone.

registration_email_as_usernameboolean

Whether email addresses are used as usernames during registration.

login_with_email_allowedboolean

Whether users can sign in with their email address instead of username.

duplicate_emails_allowedboolean

Whether multiple accounts may share the same email address.

Example request

{
  "enabled": false
}

Response

The request has succeeded.

idstring uuid required

Keycloak realm ID. This is a UUID generated by Keycloak.

namestring required

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

display_namestring required
enabledboolean required

Whether users can sign in to this realm.

ssl_required'external' | 'all' | 'none' required

Keycloak SSL requirement. Maps directly to Keycloak's sslRequired realm setting.

registration_allowedboolean required

Whether self-registration is open to anyone.

registration_email_as_usernameboolean required

Whether email addresses are used as usernames during registration.

login_with_email_allowedboolean required

Whether users can sign in with their email address instead of username.

duplicate_emails_allowedboolean required

Whether multiple accounts may share the same email address.

created_atstring date-time

Time when the realm was created, when available.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "customer-portal",
  "display_name": "Customer Portal",
  "enabled": true,
  "ssl_required": "external",
  "registration_allowed": false,
  "registration_email_as_username": false,
  "login_with_email_allowed": true,
  "duplicate_emails_allowed": false
}

Changes

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