This is a REST API reference for the Keycloak Admin
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://keycloak.local
auth: b e a r
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
This is a REST API reference for the Keycloak Admin
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Get themes, social providers, auth providers, and event listeners available on this server Root |
POST | / | Import a realm Imports a realm from a full representation of that realm. Realms Admin |
GET | /{id}/name | Need this for admin console to display simple name of provider when displaying client detail KEYCLOAK-4328 U |
GET | /{realm} | Get the top-level representation of the realm It will not include nested information like User and Client re |
PUT | /{realm} | Update the top-level information of the realm Any user, roles or client information in the representation w |
DELETE | /{realm} | Delete the realm Realms Admin |
GET | /{realm}/admin-events | Get admin events Returns all admin events, or filters events based on URL query parameters listed here Realm |
DELETE | /{realm}/admin-events | Delete all admin events Realms Admin |
DELETE | /{realm}/attack-detection/brute-force/users | Clear any user login failures for all users This can release temporary disabled users Attack Detection |
GET | /{realm}/attack-detection/brute-force/users/{userId} | Get status of a username in brute force detection Attack Detection |
DELETE | /{realm}/attack-detection/brute-force/users/{userId} | Clear any user login failures for the user This can release temporary disabled user Attack Detection |
GET | /{realm}/authentication/authenticator-providers | Get authenticator providers Returns a list of authenticator providers. Authentication Management |
GET | /{realm}/authentication/client-authenticator-providers | Get client authenticator providers Returns a list of client authenticator providers. Authentication Manageme |
GET | /{realm}/authentication/config-description/{providerId} | Get authenticator provider’s configuration description Authentication Management |
GET | /{realm}/authentication/config/{id} | Get authenticator configuration Authentication Management |
PUT | /{realm}/authentication/config/{id} | Update authenticator configuration Authentication Management |
DELETE | /{realm}/authentication/config/{id} | Delete authenticator configuration Authentication Management |
POST | /{realm}/authentication/executions | Add new authentication execution Authentication Management |
GET | /{realm}/authentication/executions/{executionId} | Get Single Execution Authentication Management |
DELETE | /{realm}/authentication/executions/{executionId} | Delete execution Authentication Management |
POST | /{realm}/authentication/executions/{executionId}/config | Update execution with new configuration Authentication Management |
POST | /{realm}/authentication/executions/{executionId}/lower-priority | Lower execution’s priority Authentication Management |
POST | /{realm}/authentication/executions/{executionId}/raise-priority | Raise execution’s priority Authentication Management |
GET | /{realm}/authentication/flows | Get authentication flows Returns a list of authentication flows. Authentication Management |
POST | /{realm}/authentication/flows | Create a new authentication flow Authentication Management |
POST | /{realm}/authentication/flows/{flowAlias}/copy | Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passe |
GET | /{realm}/authentication/flows/{flowAlias}/executions | Get authentication executions for a flow Authentication Management |
PUT | /{realm}/authentication/flows/{flowAlias}/executions | Update authentication executions of a flow Authentication Management |
POST | /{realm}/authentication/flows/{flowAlias}/executions/execution | Add new authentication execution to a flow Authentication Management |
POST | /{realm}/authentication/flows/{flowAlias}/executions/flow | Add new flow with new execution to existing flow Authentication Management |
GET | /{realm}/authentication/flows/{id} | Get authentication flow for id Authentication Management |
PUT | /{realm}/authentication/flows/{id} | Update an authentication flow Authentication Management |
DELETE | /{realm}/authentication/flows/{id} | Delete an authentication flow Authentication Management |
GET | /{realm}/authentication/form-action-providers | Get form action providers Returns a list of form action providers. Authentication Management |
GET | /{realm}/authentication/form-providers | Get form providers Returns a list of form providers. Authentication Management |
GET | /{realm}/authentication/per-client-config-description | Get configuration descriptions for all clients Authentication Management |
POST | /{realm}/authentication/register-required-action | Register a new required actions Authentication Management |
GET | /{realm}/authentication/required-actions | Get required actions Returns a list of required actions. Authentication Management |
GET | /{realm}/authentication/required-actions/{alias} | Get required action for alias Authentication Management |
PUT | /{realm}/authentication/required-actions/{alias} | Update required action Authentication Management |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/ccouzens/keycloak-openapi/master/keycloak/10.0.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.