Get a realm
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--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'Returns a single realm by name.
Required scope: realms:read
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”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.
The public URL the realm serves on when you put your own proxy in front of the cluster,
or null when none is set. While it is set, the realm’s issuer is this URL followed by
/realms/{name} whatever host a request arrives on. Always null for a realm that
serves on a Skycloak custom domain.
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,
"frontend_url": null
}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
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"
}