How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keycloak Realms API

Manage Keycloak realms

Keycloak Realms API is one of 6 APIs that Keycloak publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Realms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, and 3 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 26.0.0.

Requests are made against a single base URL, https://{host}/admin/realms.

4 operations 2 paths 7 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.0.0
Server
https://{host}/admin/realms
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Keycloak Realms API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Access token obtained from the Keycloak token endpoint. Use the master realm admin credentials or a service account with appropriate realm-management roles.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Realms 4

Manage Keycloak realms

GET
/
Keycloak List all realms
getRealms 1 param → 200
GET
/{realm}
Keycloak Get a realm
getRealm 1 param → 200404
PUT
/{realm}
Keycloak Update a realm
updateRealm 1 param body → 204404
DELETE
/{realm}
Keycloak Delete a realm
deleteRealm 1 param → 204404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are RealmRepresentation (55 properties), ClientRepresentation (27 properties), UserRepresentation (19 properties), IdentityProviderRepresentation (13 properties). Each schema is shown below with its type and property counts.

UserRepresentation
object
Representation of a Keycloak user
19 properties
IdentityProviderRepresentation
object
Representation of a federated identity provider
13 properties
RealmRepresentation
object
Representation of a Keycloak realm
55 properties
GroupRepresentation
object
Representation of a user group in Keycloak
7 properties
ClientRepresentation
object
Representation of an OAuth/OIDC client registered in Keycloak
27 properties
RoleRepresentation
object
Representation of a role in Keycloak
8 properties
CredentialRepresentation
object
Representation of a user credential
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keycloak-realms-api-openapi.yml Raw ↑

Other APIs Keycloak publishes across the network.

Keycloak Clients API
Keycloak Groups API
Keycloak Identity Providers API
Keycloak Roles API
Keycloak Users API
Where this information came from

This is an independent, third-party profile of Keycloak Realms API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.