Update a realm
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal';
const options = {
method: 'PATCH',
headers: {
'API-Version': '2026-06-01.beta',
'API-Key': '<API-Key>',
'Content-Type': 'application/json'
},
body: '{"enabled":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request PATCH \
--url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta' \
--header 'Content-Type: application/json' \
--data '{ "enabled": false }'Partially updates realm settings.
Required scope: realms:write
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.
Example
customer-portalHeader Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Patch request for updating realm settings. At least one field should be provided.
object
Example
Customer PortalWhether users can sign in to this realm.
Example
trueKeycloak SSL requirement. Maps directly to Keycloak’s sslRequired realm setting.
Whether self-registration is open to anyone.
Example
falseWhether email addresses are used as usernames during registration.
Example
falseWhether users can sign in with their email address instead of username.
Example
trueWhether multiple accounts may share the same email address.
Example
falseExample
{
"enabled": false
}Responses
Section titled “Responses”The request has succeeded.
Realm details.
object
Whether users can sign in to this realm.
Keycloak SSL requirement. Maps directly to Keycloak’s sslRequired realm setting.
Whether self-registration is open to anyone.
Whether email addresses are used as usernames during registration.
Whether users can sign in with their email address instead of username.
Whether multiple accounts may share the same email address.
Time when the realm was created, when available.
Example
{
"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
}Access is unauthorized.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is forbidden.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
object
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"errors": [
{
"field": "example",
"detail": "example",
"code": "example",
"value": "example"
}
]
}Client error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}