Keycloak Admin REST API

Name: Keycloak Admin REST API
Brand: Keycloak Admin REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentIdentity AuthAuthenticationnone-declared387 EndpointsREST

For Agents

Administer realms, clients, users, groups, organisations, identity providers, authentication flows, keys, and protocol mappers across the full 387-endpoint Keycloak admin surface.

Install Jentic One Beta

Connect the Keycloak Admin REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Keycloak Admin REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Keycloak Admin REST API.

Create, read, update, and delete realms and inspect realm-level admin events

Manage clients, client scopes, protocol mappers, and per-client role mappings

Manage users, groups, and organisations along with their membership and role mappings

GET STARTED

Start building with Keycloak Admin REST API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Keycloak Admin REST API, keeping it validated and agent-ready. The Keycloak Admin REST API is the management surface for Keycloak's open-source identity and access management server. The 387 endpoints cover the full admin surface: realms, clients, client scopes, role mappings, users, groups, organisations, identity providers, authentication flows, key management, components, protocol mappers, attack detection, and client initial-access tokens. Most endpoints sit under /admin/realms/{realm} and accept JSON bodies that map to Keycloak's representation classes. Although this spec does not declare a security scheme, every Keycloak admin call in practice requires a bearer access token issued by Keycloak's own OIDC endpoints.

Use Cases

Patterns agents use Keycloak Admin REST API for, with concrete tasks.

★ Multi-Tenant Realm Provisioning

Create a fresh realm per tenant when onboarding a new customer, including the clients, default groups, and identity providers each tenant needs. The /admin/realms endpoints support full CRUD and the per-realm subtrees (clients, groups, identity providers) configure everything else. Provisioning a tenant becomes a deterministic script rather than a manual checklist.

POST /admin/realms with the realm representation, then POST clients, identity providers, and groups under /admin/realms/{realm}

Identity Federation Configuration

Wire up SAML or OIDC identity providers per realm by calling the /identity-provider endpoints under /admin/realms/{realm}. The same set of endpoints supports listing, reading, updating, and removing providers, plus mapping their incoming claims onto Keycloak attributes. This makes federation changes auditable through code review rather than admin-console clicks.

POST /admin/realms/{realm}/identity-provider/instances with the new SAML or OIDC provider representation

Compliance and Admin-Event Auditing

Pull the realm admin event stream periodically to feed a SIEM or audit pipeline. The /admin-events endpoint returns a paginated list of administrative actions taken inside the realm, and the related delete endpoint clears the audit buffer when needed. Combined with user role-mapping reads, this builds a complete picture of who has what access and how it changed.

GET /admin/realms/{realm}/admin-events with a date filter, paginate through the result, and forward the events to the SIEM

AI Agent Keycloak Operations

An AI agent that helps an identity team manage Keycloak uses Jentic to find the correct admin operation for each request — list a realm's clients, unlock a user, configure a new identity provider — without manually walking a 387-endpoint spec. Jentic injects the bearer token per call and returns a focused operation schema for the agent to fill in.

Through Jentic, search for 'list keycloak clients', load GET /admin/realms/{realm}/clients, and execute it for the supplied realm

Key Endpoints

387 endpoints — jentic publishes the only available openapi specification for keycloak admin rest api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/admin/realms

List all realms

POST

/admin/realms

Create a new realm

GET

/admin/realms/{realm}

Read a realm by name

PUT

/admin/realms/{realm}

Update a realm

DELETE

/admin/realms/{realm}

Delete a realm

GET

/admin/realms/{realm}/admin-events

Read realm admin events

DELETE

/admin/realms/{realm}/attack-detection/brute-force/users/{userId}

Clear brute-force lockout for a user

GET

/admin/realms/{realm}/authentication/authenticator-providers

List authenticator providers

GET

/admin/realms

List all realms

POST

/admin/realms

Create a new realm

GET

/admin/realms/{realm}

Read a realm by name

PUT

/admin/realms/{realm}

Update a realm

DELETE

/admin/realms/{realm}

Delete a realm

GET

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Keycloak admin credentials are stored encrypted in the Jentic vault. Jentic exchanges them at the OIDC token endpoint and supplies the bearer per call, so client_secret values never enter the agent's context.

Intent-based discovery

Agents search by intent (e.g. 'unlock a keycloak user' or 'list clients in a realm') and Jentic returns the matching admin operation with its schema, so the agent does not have to walk a 387-endpoint surface.

Time to first call

Direct Keycloak admin integration: 3-7 days for OIDC token handling, schema modelling, and pagination across the large surface. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using Keycloak Admin REST API through Jentic.

Why is there no official OpenAPI spec for Keycloak Admin REST API?

Keycloak does not publish a curated OpenAPI specification for its admin API as part of its release artefacts. Jentic generates and maintains this spec so that AI agents and developers can call Keycloak Admin REST API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Keycloak Admin REST API use?

Bearer access tokens issued by Keycloak's own OIDC token endpoint. Although the OpenAPI spec does not declare the security scheme explicitly, every admin call requires the Authorization header. Through Jentic the client_id, client_secret, and admin credentials live in the encrypted vault and Jentic mints the bearer per call.

Can I list every client in a realm with the Keycloak Admin REST API?

Yes. GET /admin/realms/{realm}/clients returns the clients configured in the realm. Use GET /admin/realms/{realm}/clients/{id} to drill into a single client and its protocol mappers, role mappings, and client scopes.

What are the rate limits for the Keycloak Admin REST API?

Keycloak does not enforce a fixed numeric rate limit out of the box — throughput is bounded by the JVM and database behind your deployment. For high-volume admin tooling, batch reads and avoid hot-looping on /admin/realms/{realm}/admin-events.

How do I create a new realm through Jentic?

Search Jentic for 'create a keycloak realm' to find POST /admin/realms, load its schema, and execute it with the realm representation. The Jentic flow is pip install jentic, then client.search, client.load, and client.execute.

Does this spec cover organisations and identity providers?

Yes. The /admin/realms/{realm}/organizations endpoints manage organisations within a realm, and /admin/realms/{realm}/identity-provider/instances manages SAML and OIDC identity providers. Both are part of the 387-endpoint surface.

How do I clear a brute-force lockout via the API?

DELETE /admin/realms/{realm}/attack-detection/brute-force/users/{userId} resets brute-force state for one user. The realm-wide endpoint at the same root clears the entire bucket for all users in the realm.

Keycloak Admin REST API

Connect the Keycloak Admin REST API to your agent

Capabilities

Start building with Keycloak Admin REST API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs