Keycloak Roles API
Manage realm-level and client-level roles
Keycloak Roles 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 Roles. 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 8 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 26.0.0.
Requests are made against a single base URL, https://{host}/admin/realms.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Keycloak Roles 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 8
Across 3 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Manage realm-level and client-level roles
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is RoleRepresentation (8 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Keycloak 5
Other APIs Keycloak publishes across the network.