keycloak.local

This is a REST API reference for the Keycloak Admin

🔑 bearer 281 endpoints developer_tools
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (8 total)

pip install aiokeycloak
pip install keycloak-sdk
npm install keycloak-admin-sdk
# Maven: see https://github.com/embesozzi/keycloak-openfga-event-publisher
dotnet add package KeycloakWebMVCSample
dotnet add package Keycloak.Net
composer require keycloak-php-sdk
# See https://github.com/OpenPj/keycloak-docker-quickstart
curl examples
Get themes, social providers, auth providers, and event listeners available o…
curl \
  -H "Authorization: Bearer $API_KEY" \
  http://keycloak.local/
Get the top-level representation of the realm It will not include nested in…
curl \
  -H "Authorization: Bearer $API_KEY" \
  http://keycloak.local/{realm}
Need this for admin console to display simple name of provider when displayin…
curl \
  -H "Authorization: Bearer $API_KEY" \
  http://keycloak.local/{id}/name
Endpoints (281 total)
GET
/
Get themes, social providers, auth providers, and event listeners available o…
GET
/{realm}
Get the top-level representation of the realm It will not include nested in…
GET
/{id}/name
Need this for admin console to display simple name of provider when displayin…
GET
/{realm}/keys
GET
/{realm}/roles
Get all roles for the realm or client
GET
/{realm}/users
Get users Returns a list of users, filtered according to query parameters
GET
/{realm}/events
Get events Returns all events, or filters them based on URL query parameter…
GET
/{realm}/groups
Get group hierarchy.
GET
/{realm}/clients
Get clients belonging to the realm Returns a list of clients belonging to t…
GET
/{realm}/components
GET
/{realm}/users/{id}
Get representation of the user
GET
/{realm}/groups/{id}
At a glance
Total SDKs8
Languages6
Endpoints281
Authbearer
Categories1
http://keycloak.local