# Keycloak Realms Admin API

**Canonical:** https://apis.io/apis/keycloak/keycloak-realms-admin-api/  
**Provider:** Keycloak — https://apis.io/providers/keycloak/  
**Documentation:** https://www.keycloak.org/docs-api/latest/rest-api/

Keycloak Realms Admin API is one of 23 APIs that [Keycloak](https://apis.io/providers/keycloak/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Realms Admin. The published artifact set on APIs.io includes an OpenAPI specification.

The Realms Admin API from Keycloak — 28 operation(s) for realms admin.

## Operations (45)

| Method | Path | Summary |
|---|---|---|
| GET | `/admin/realms` | Get accessible realms Returns a list of accessible realms. |
| POST | `/admin/realms` | Import a realm. Imports a realm from a full representation of that realm |
| GET | `/admin/realms/{realm}` | Get the top-level representation of the realm It will not include nested… |
| PUT | `/admin/realms/{realm}` | Update the top-level information of the realm Any user, roles or client… |
| DELETE | `/admin/realms/{realm}` | Delete the realm |
| GET | `/admin/realms/{realm}/admin-events` | Get admin events Returns all admin events, or filters events based on URL query… |
| DELETE | `/admin/realms/{realm}/admin-events` | Delete all admin events |
| POST | `/admin/realms/{realm}/client-description-converter` | Base path for importing clients under this realm |
| GET | `/admin/realms/{realm}/client-policies/policies` | Get admin realms by realm client policies policies |
| PUT | `/admin/realms/{realm}/client-policies/policies` | Replace admin realms by realm client policies policies |
| GET | `/admin/realms/{realm}/client-policies/profiles` | Get admin realms by realm client policies profiles |
| PUT | `/admin/realms/{realm}/client-policies/profiles` | Replace admin realms by realm client policies profiles |
| GET | `/admin/realms/{realm}/client-session-stats` | Get client session stats Returns a JSON map |
| GET | `/admin/realms/{realm}/client-types` | List all client types available in the current realm |
| PUT | `/admin/realms/{realm}/client-types` | Update a client type |
| GET | `/admin/realms/{realm}/credential-registrators` | Get admin realms by realm credential registrators |
| GET | `/admin/realms/{realm}/default-default-client-scopes` | Get realm default client scopes. Only name and ids are returned |
| PUT | `/admin/realms/{realm}/default-default-client-scopes/{clientScopeId}` | Replace admin realms by realm default default client scopes by client scope id |
| DELETE | `/admin/realms/{realm}/default-default-client-scopes/{clientScopeId}` | Delete admin realms by realm default default client scopes by client scope id |
| GET | `/admin/realms/{realm}/default-groups` | Get group hierarchy. Only name and ids are returned |
| PUT | `/admin/realms/{realm}/default-groups/{groupId}` | Replace admin realms by realm default groups by group id |
| DELETE | `/admin/realms/{realm}/default-groups/{groupId}` | Delete admin realms by realm default groups by group id |
| GET | `/admin/realms/{realm}/default-optional-client-scopes` | Get realm optional client scopes. Only name and ids are returned |
| PUT | `/admin/realms/{realm}/default-optional-client-scopes/{clientScopeId}` | Replace admin realms by realm default optional client scopes by client scope id |
| DELETE | `/admin/realms/{realm}/default-optional-client-scopes/{clientScopeId}` | Delete admin realms by realm default optional client scopes by client scope id |
| GET | `/admin/realms/{realm}/events` | Get events Returns all events, or filters them based on URL query parameters… |
| DELETE | `/admin/realms/{realm}/events` | Delete all events |
| GET | `/admin/realms/{realm}/events/config` | Get the events provider configuration Returns JSON object with events provider… |
| PUT | `/admin/realms/{realm}/events/config` | Replace admin realms by realm events config |
| GET | `/admin/realms/{realm}/group-by-path/{path}` | Get admin realms by realm group by path by path |
| GET | `/admin/realms/{realm}/localization` | Get admin realms by realm localization |
| GET | `/admin/realms/{realm}/localization/{locale}` | Get admin realms by realm localization by locale |
| POST | `/admin/realms/{realm}/localization/{locale}` | Import localization from uploaded JSON file |
| DELETE | `/admin/realms/{realm}/localization/{locale}` | Delete admin realms by realm localization by locale |
| GET | `/admin/realms/{realm}/localization/{locale}/{key}` | Get admin realms by realm localization by locale by key |
| PUT | `/admin/realms/{realm}/localization/{locale}/{key}` | Replace admin realms by realm localization by locale by key |
| DELETE | `/admin/realms/{realm}/localization/{locale}/{key}` | Delete admin realms by realm localization by locale by key |
| POST | `/admin/realms/{realm}/logout-all` | Removes all user sessions |
| POST | `/admin/realms/{realm}/partial-export` | Partial export of existing realm into a JSON file |
| POST | `/admin/realms/{realm}/partialImport` | Partial import from a JSON file to an existing realm |
| POST | `/admin/realms/{realm}/push-revocation` | Push the realm's revocation policy to any client that has an admin url… |
| DELETE | `/admin/realms/{realm}/sessions/{session}` | Remove a specific user session |
| POST | `/admin/realms/{realm}/testSMTPConnection` | Test SMTP connection with current logged in user |
| GET | `/admin/realms/{realm}/users-management-permissions` | Get admin realms by realm users management permissions |
| PUT | `/admin/realms/{realm}/users-management-permissions` | Replace admin realms by realm users management permissions |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/keycloak/openapi/keycloak-realms-admin-api-openapi.yml

## Other Keycloak APIs (12)

- [Keycloak Clients API](https://apis.io/apis/keycloak/keycloak-clients-api/)
- [Keycloak Groups API](https://apis.io/apis/keycloak/keycloak-groups-api/)
- [Keycloak Identity Providers API](https://apis.io/apis/keycloak/keycloak-identity-providers-api/)
- [Keycloak Realms API](https://apis.io/apis/keycloak/keycloak-realms-api/)
- [Keycloak Roles API](https://apis.io/apis/keycloak/keycloak-roles-api/)
- [Keycloak Users API](https://apis.io/apis/keycloak/keycloak-users-api/)
- [Keycloak Admin API](https://apis.io/apis/keycloak/keycloak-admin-api/)
- [Keycloak Attack Detection API](https://apis.io/apis/keycloak/keycloak-attack-detection-api/)
- [Keycloak Authentication Management API](https://apis.io/apis/keycloak/keycloak-authentication-management-api/)
- [Keycloak Client Attribute Certificate API](https://apis.io/apis/keycloak/keycloak-client-attribute-certificate-api/)
- [Keycloak Client Initial Access API](https://apis.io/apis/keycloak/keycloak-client-initial-access-api/)
- [Keycloak Client Registration Policy API](https://apis.io/apis/keycloak/keycloak-client-registration-policy-api/)

## Tags

Realms Admin

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/keycloak/keycloak-realms-admin-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/keycloak/.