Skip to main content
Glama

skycloak-mcp

Smithery

Offizieller Model Context Protocol-Server für Skycloak (verwaltetes Keycloak): Verwalten Sie Ihre Cluster, Realms, Anwendungen und SSO über jeden MCP-Client (Claude Desktop, Claude Code, Cursor).

Status: frühe Veröffentlichung. Die Tool-Abdeckung wächst; sehen Sie sich das Changelog an, um zu erfahren, was verfügbar ist.

Quick start

claude mcp add --transport http skycloak https://mcp.skycloak.io

Kein API-Schlüssel, keine Client-ID, keine Konfiguration. Ihr Browser öffnet sich, Sie melden sich bei Skycloak an, und die Tools erscheinen. Jeder MCP-Client, der streamable HTTP unterstützt, funktioniert auf die gleiche Weise: Geben Sie die URL an und sonst nichts.

Dann fragen Sie nach etwas:

  • "Welche meiner Keycloak-Cluster sind bei Upgrades im Rückstand?"

  • "Erstellen Sie ein Staging-Realm auf dem EU-Cluster mit Google- und GitHub-Anmeldung."

  • "Wer wurde in der letzten Woche zum Produktions-Realm hinzugefügt?"

  • "Richten Sie ein SIEM-Ziel ein, das Admin-Events an unseren Datadog-Webhook weiterleitet."

Related MCP server: MCP Authentik

Authentifizierung & Sicherheit

  • Gehostetes HTTP, mit OAuth (keine Anmeldedaten zum Konfigurieren). Weisen Sie Ihren Client auf https://mcp.skycloak.io an, ohne Header. Der Server antwortet mit 401 und einem Verweis auf seine RFC 9728-Metadaten unter /.well-known/oauth-protected-resource, der Client führt den Browser-Autorisierungscode-Flow gegen das Skycloak-Login-Realm aus, und das erhaltene Zugriffstoken wird gegen einen kurzlebigen, workspace-bezogenen API-Schlüssel ausgetauscht, auf dem die Sitzung läuft. Der Schlüssel ist eine Stunde gültig und wird automatisch erneuert. Nichts wird in Ihrer Client-Konfiguration gespeichert.

  • Gehostetes HTTP, mit einem API-Schlüssel. Erstellen Sie einen Schlüssel im Skycloak-Dashboard und senden Sie ihn als Authorization: Bearer <key> (oder API-Key: <key>). Jede Anfrage trägt ihre eigene Anmeldeinformation und agiert nur als der Workspace dieser Anmeldeinformation. Der Server behält keinen Sitzungszustand, sodass eine Anfrage niemals die eines anderen Aufrufers erbt. Schlüssel werden vor der Verwendung nicht überprüft: Die Skycloak-API ist die Autorität, sodass ein ungültiger Schlüssel beim ersten Tool-Aufruf als 401 erscheint, nicht beim Verbindungsaufbau.

  • Tools passen zu Ihrer Rolle. Bei OAuth wird die Tool-Liste auf das reduziert, was die Sitzungsberechtigungen erlauben, sodass einem schreibgeschützten Workspace-Mitglied keine Schreib-Tools angezeigt werden, die mit 403 antworten würden. Mit einem API-Schlüssel wird die gesamte Oberfläche registriert, da die Berechtigungen eines Schlüssels für den Server nicht sichtbar sind, und ein nicht autorisierter Aufruf erscheint als 403 von der API.

  • Lokales stdio. Führen Sie skycloak-mcp init aus und bestätigen Sie in Ihrem Browser (OAuth 2.0-Geräteautorisierungs-Flow). Es erstellt einen workspace-bezogenen API-Schlüssel, speichert ihn in Ihrer Betriebssystem-Tasche (keychain) und erkennt automatisch Ihren Standard-Workspace (übergeben Sie --workspace <id>, um einen anderen auszuwählen). skycloak-mcp logout entfernt den gespeicherten Schlüssel.

  • Headless / CI. Setzen Sie die Umgebungsvariable SKYCLOAK_API_KEY (erstellen Sie einen Schlüssel im Skycloak-Dashboard), um den Browser vollständig zu überspringen. Sie hat immer Vorrang vor der Schlüsseltasche.

  • Schreibvorgänge werden durch Ihre Anmeldeinformation gesteuert, nicht durch ein Flag. Der gehostete Server unter https://mcp.skycloak.io läuft schreibfähig, und was Sie tatsächlich ändern können, wird durch die Berechtigungen Ihres Schlüssels und Ihre Workspace-Rolle begrenzt: Ein schreibgeschütztes Mitglied kann nichts ändern, egal was die Tool-Liste sagt. Fügen Sie ?readonly=true zur URL hinzu, um für eine Sitzung eine schreibgeschützte Tool-Oberfläche zu erzwingen. Das lokale Binary ist genau umgekehrt und registriert keine Schreib-Tools, es sei denn, es wird mit --allow-writes gestartet.

  • Cluster-Anmeldeinformationen sind opt-in. get_cluster_credentials gibt die Keycloak-Admin-Anmeldeinformationen eines Clusters zurück, die ein den Schlüssel haltender Assistent dann sehen würde, daher fordert init diesen Bereich standardmäßig nicht an. Verwenden Sie einen Schlüssel, der diesen Bereich enthält: Erstellen Sie einen im Dashboard, oder melden Sie sich über stdio mit skycloak-mcp init --allow-credentials an. Ohne diesen gibt das Tool einen 403 zurück, der beide Wege erklärt.

  • Zerstörerische Tools erfordern Bestätigung: Das Löschen eines Realms erfordert beispielsweise ein explizites confirm=true-Argument.

  • Anfragen werden gemäß Ihrem Skycloak-Plan ratenbegrenzt; bei einer 429-Antwort gibt der Server Retry-After an.

Tools

129 Tools: 58 schreibgeschützt und 71 schreibend. Schreibgeschützte Tools sind immer verfügbar. Auf dem gehosteten Server werden die Schreib-Tools ebenfalls registriert und durch die Berechtigungen Ihrer Anmeldeinformation gesteuert; das lokale Binary registriert sie nur, wenn es mit --allow-writes gestartet wird.

Tool-Namen tragen ein skycloak_-Präfix, das die folgende Tabelle weglässt, daher ist list_clusters in Ihrem Client skycloak_list_clusters.

Bereich

Schreibgeschützt

Schreiben (--allow-writes)

Cluster

list_clusters, get_cluster, list_cluster_locations, list_cluster_types, list_cluster_features, list_cluster_versions, list_cluster_upgrades, get_cluster_upgrade_path, get_cluster_credentials, get_cluster_insights, get_cluster_maintenance_window

create_cluster, update_cluster, delete_cluster, cancel_cluster_upgrade, set_cluster_maintenance_window, delete_cluster_maintenance_window

Edge-Sicherheit

get_cluster_security, list_cluster_captcha_domains

update_cluster_security, add_cluster_captcha_domain, remove_cluster_captcha_domain

Bereiche

list_realms, get_realm

create_realm, update_realm, delete_realm

Anwendungen

list_applications, get_application, list_application_roles, list_application_sessions

create_application, update_application, delete_application, assign_application_role, remove_application_role, rotate_application_secret

Identitätsanbieter

list_identity_providers, get_identity_provider, list_identity_provider_templates, discover_oidc

create_identity_provider (OIDC), update_identity_provider, delete_identity_provider, test_identity_provider

Benutzer, Rollen & Gruppen

list_realm_users, get_realm_user, list_realm_roles, get_realm_role, list_realm_groups, get_realm_group, list_realm_group_members, list_user_roles, list_user_groups

create_realm_user, update_realm_user, delete_realm_user, create_realm_role, update_realm_role, delete_realm_role, create_realm_group, update_realm_group, delete_realm_group, assign_realm_user_role, remove_realm_user_role, add_realm_user_to_group, remove_realm_user_from_group

Benutzerdefinierte Domains

list_domains, get_domain, list_domain_routes, get_domain_route

create_domain, verify_domain, delete_domain, create_domain_route, update_domain_route, delete_domain_route

Branding & Themes

list_themes, get_theme, get_theme_assignment, get_client_theme_assignment, get_login_branding, get_email_branding, download_theme_content

set_theme_assignment, set_client_theme_assignment, update_theme, delete_theme, upsert_login_branding, delete_login_branding, upsert_email_branding, delete_email_branding

Erweiterungen

list_extensions, list_cluster_extensions

install_extension, upgrade_extension, update_extension, uninstall_extension, delete_extension

SMTP

get_smtp

upsert_smtp, delete_smtp, test_smtp

Exporte & Logs

list_exports, get_export, get_logs, get_security_logs, query_events

create_export, delete_export, export_cluster_events

Bereichsimport & -export

get_realm_export, get_realm_import

create_realm_export, create_realm_import, create_realm_import_upload_url

SIEM

list_siem_destinations, get_siem_destination

create_siem_destination, update_siem_destination, delete_siem_destination, test_siem_destination

Webhooks

list_webhook_event_types, list_webhook_subscriptions, get_webhook_subscription

create_webhook_subscription, update_webhook_subscription, delete_webhook_subscription, test_webhook_subscription

Konventionen: Zerstörerische Werkzeuge (delete_*, uninstall_extension, cancel_cluster_upgrade) erfordern confirm=true. create_cluster ist asynchron: Pollen Sie get_cluster, bis der Cluster available ist. create_domain gibt die DNS-Einträge zurück, die der Kunde erstellen muss; verify_domain löst eine DNS-Überprüfung aus. set_theme_assignment aktiviert ein benutzerdefiniertes Theme pro Keycloak-Theme-Typ (leerer String setzt auf das eingebaute Standard-Theme zurück). update_cluster_security lässt CAPTCHA-Einstellungen unberührt. Bereichsimport/-export verschiebt die Konfiguration eines Bereichs und ist getrennt von create_export, das die gesamte Datenbank eines Clusters sichert: Beide sind asynchron, und das Bereichsarchiv ist immer verschlüsselt, daher wird das Passwort, das zum Exportieren verwendet wurde, zum erneuten Importieren benötigt. Ein Bereich kann direkt aus einem vorhandenen Export (source_export_id) oder aus einem hochgeladenen Archiv (create_realm_import_upload_url, PUT, dann upload_s3_key) importiert werden; das Importieren erstellt einen Bereich und verweigert eine Namenskollision anstatt zu überschreiben, und benötigt confirm=true, da es Benutzer und Anmeldeinformationen mitbringt.

Verbinden

Für gehostetes HTTP ist der einfachste Weg OAuth, der überhaupt keine Anmeldeinformationen benötigt:

claude mcp add --transport http skycloak https://mcp.skycloak.io

Der erste Aufruf öffnet Ihren Browser, Sie bestätigen auf der Skycloak-Anmeldeseite, und die Werkzeuge erscheinen. Wenn Sie zu mehr als einem Arbeitsbereich gehören, geben Sie den gewünschten an:

claude mcp add --transport http skycloak "https://mcp.skycloak.io?workspace=<workspace-id>"

Andernfalls erstellen Sie einen API-Schlüssel im Skycloak-Dashboard und konfigurieren Sie Ihren MCP-Client so, dass er ihn als Bearer-Token sendet:

claude mcp add --transport http skycloak https://mcp.skycloak.io --header "Authorization: Bearer sk_sc_XXX"

Dies fügt Folgendes zu .claude.json hinzu:

{
  "mcpServers": {
    "skycloak": {
      "type": "http",
      "url": "https://mcp.skycloak.io",
      "headers": {
        "Authorization": "Bearer sk_sc_XXX"
      }
    }
  }
}

Für lokales stdio melden Sie sich einmal an und weisen dann Ihren Client auf skycloak-mcp run an:

skycloak-mcp init        # one-time browser sign-in; stores a key in your keychain

Claude Desktop / Cursor (lokal, stdio):

{
  "mcpServers": {
    "skycloak": {
      "command": "skycloak-mcp",
      "args": ["run", "--transport", "stdio"]
    }
  }
}

Claude Code:

claude mcp add skycloak -- skycloak-mcp run --transport stdio

Für headless / CI (kein Browser) überspringen Sie init und übergeben Sie stattdessen den Schlüssel: Fügen Sie "env": { "SKYCLOAK_API_KEY": "sk_sc_..." } zur Konfiguration hinzu, oder claude mcp add skycloak --env SKYCLOAK_API_KEY=sk_sc_... -- skycloak-mcp run --transport stdio.

Fügen Sie --allow-writes nur hinzu, wenn Sie Änderungen vornehmen möchten (melden Sie sich mit skycloak-mcp init --allow-writes an oder verwenden Sie einen Schlüssel mit Schreibberechtigung).

Fügen Sie ?readonly=true zu einer gehosteten HTTP-URL hinzu, um nur schreibgeschützte Werkzeuge für diese HTTP-Sitzung verfügbar zu machen, oder ?readonly=false, um die schreibfähige Werkzeugoberfläche anzufordern. Der Abfrageparameter hat standardmäßig den Wert false, aber Schreibwerkzeuge werden nur registriert, wenn der Server mit --allow-writes gestartet wurde.

Fügen Sie ?workspace=<uuid> hinzu, um auszuwählen, auf welchen Workspace eine OAuth-Sitzung wirkt. Es wird nur benötigt, wenn Sie mehr als einem Workspace angehören; bei einem einzelnen Workspace wählt der Server ihn für Sie aus. Wenn Sie mehreren angehören und keinen nennen, schlägt die Verbindung mit einer Nachricht fehl, die diese auflistet.

Running the HTTP transport

skycloak-mcp run --transport http --http-addr :8080

Es benötigt keine eigenen Anmeldeinformationen: Aufrufer liefern ihre pro Anfrage, sodass zum Zeitpunkt der Bereitstellung nichts injiziert wird. GET /healthz und GET /readyz sind nicht authentifiziert und melden nur, dass der Prozess läuft; sie testen bewusst nicht die Skycloak-API, sodass eine kurzzeitige Störung eines vorgelagerten Dienstes nicht gleichzeitig die Prüfung aller Replikate zum Scheitern bringen kann. Der Server speichert keinen Sitzungszustand, daher benötigen Replikate keine Sitzungsaffinität und können frei skaliert oder aktualisiert werden. SIGTERM stoppt neue Verbindungen und lässt laufende Aufrufe auslaufen.

Der OAuth-Pfad ist aktiv, sobald SKYCLOAK_ISSUER und SKYCLOAK_DASHBOARD_URL gesetzt sind, was standardmäßig der Fall ist. GET /.well-known/oauth-protected-resource wird dann ohne Authentifizierung bereitgestellt und benennt den Realm als den Autorisierungsserver. Sein resource-Wert wird aus SKYCLOAK_PUBLIC_URL übernommen, falls gesetzt, andernfalls aus dem Host- und Schema des Requests, sodass eine Einzelhost-Bereitstellung hinter einem Ingress keine zusätzliche Konfiguration benötigt. Das Schema stammt aus X-Forwarded-Proto, falls vorhanden, andernfalls wird für alles außer einem Loopback-Host standardmäßig https verwendet, da TLS vorgelagert terminiert wird und die Veröffentlichung eines http://-Identifiers nicht mit der URL übereinstimmen würde, mit der der Client verbunden ist. Setzen Sie SKYCLOAK_PUBLIC_URL, wenn Ihr Ingress Host umschreibt. Das Dokument listet auch openid profile email als seine scopes_supported auf, und die WWW-Authenticate-Challenge wiederholt sie als scope-Parameter, sodass ein Client, der eines davon liest, den Realm danach fragt: openid ist erforderlich, da der Token-Austausch das Dashboard veranlasst, den Keycloak-Userinfo-Endpunkt aufzurufen, und Keycloak einen ohne diesen gewährten Token ablehnt. Ein Token, der ohne diesen ankommt, wird bei der Verifizierung mit einem 401 und der Challenge abgelehnt, anstatt zu einem Austausch geführt zu werden, der nicht erfolgreich sein kann, sodass ein Client, der noch ein älteres Grant besitzt, die Wiederholungsversuche einstellt und sich erneut anmeldet. Das Leeren entweder der Issuer- oder der Dashboard-Variablen schaltet OAuth vollständig aus, und der Server fordert wieder nur einen API-Schlüssel an.

Beim Start wird eine Zeile mit der aufgelösten Verkabelung protokolliert (oauth=, issuer=, dashboard=, public_url=, endpoint=, allow_writes=), sodass eine fehlkonfigurierte Bereitstellung ohne erneutes Ausrollen erkannt werden kann. Jede im OAuth-Pfad abgelehnte Anfrage protokolliert eine Zeile mit der fehlgeschlagenen Stufe (verify, exchange oder scopes), dem Status, den der Aufrufer erhielt, und dem zugrunde liegenden Fehler. Ein Verifizierungsfehler fügt die Prüfung hinzu, die den Token abgelehnt hat (expired, wrong_issuer, bad_signature, unknown_key_id, wrong_token_type, no_openid_scope usw.); ein Austauschfehler fügt den Status des Dashboards und den aufgerufenen Host hinzu. Der Aufrufer erscheint nach der Verifizierung als Subjekt des Tokens und nie als Anmeldeinformation: Das Zugriffstoken, der Authorization-Header und der generierte API-Schlüssel werden nie protokolliert.

Configuration

Env var

Default

SKYCLOAK_API_KEY

keiner (optional für stdio; HTTP-Clients stellen stattdessen API-Key-Header bereit)

SKYCLOAK_ENDPOINT

https://api.skycloak.io

SKYCLOAK_API_VERSION

aktuelle API-Version

SKYCLOAK_ISSUER

https://login.app.skycloak.io/realms/skycloak (CLI-Anmeldung und der Autorisierungsserver, gegen den der HTTP-Transport Tokens verifiziert)

SKYCLOAK_CLIENT_ID

skycloak-mcp (nur CLI-Geräteablauf)

SKYCLOAK_DASHBOARD_URL

https://app.skycloak.io (generiert CLI-Schlüssel und HTTP-Sitzungsschlüssel)

SKYCLOAK_PUBLIC_URL

keiner (aus jeder Anfrage abgeleitet; setzen Sie ihn, wenn der Ingress Host umschreibt)

Befehle: init (Browser-Anmeldung), run (Bereitstellen), logout (gespeicherten Schlüssel entfernen). init akzeptiert --workspace <id>, --allow-writes, --allow-credentials und --ttl-days (Standard 90).

Flag

Default

Description

--transport

stdio

stdio oder http

--http-addr

:8080

Lauschadresse für den HTTP-Transport

--allow-writes

false

ermöglicht verändernde Werkzeuge für stdio und erlaubt HTTP-Sitzungen mit readonly=false, um Schreibwerkzeuge zu registrieren

Development

make build      # build the server binary
make test       # unit tests
make run        # run on stdio for local testing
make inspector  # MCP Inspector against the local binary
make lint       # golangci-lint
make generate   # regenerate the API client from the OpenAPI spec

Der API-Client unter internal/apiclient wird aus der Skycloak-OpenAPI-Spezifikation mit oapi-codegen generiert.

Keeping in sync with the API

Der Client in internal/apiclient wird aus internal/apiclient/openapi.yaml mit oapi-codegen generiert; führen Sie make generate aus, um ihn zu aktualisieren. CI schlägt fehl, wenn der eingecheckte generierte Code von der Spezifikation abweicht. Anfragen werden bei 429/5xx mit Retry-After-bewusstem Backoff wiederholt.

Distribution

Wird als GitHub-Binärdateien und ein ghcr.io/sky-cloak/skycloak-mcp-Container-Image zu jedem Tag veröffentlicht und im MCP Registry als io.skycloak/skycloak-mcp veröffentlicht. Die meisten Leute benötigen keines von beiden: Der gehostete Server benötigt keine Installation.

Security

Bitte melden Sie Sicherheitslücken vertraulich. Siehe SECURITY.md.

Contributors

Erstellt bei Skycloak von Guilliano Molaire, Neville Omangi und Aphilas. Die Repository-Historie wurde beim Öffnen zusammengefasst, sodass das Commit-Log nicht widerspiegelt, wer was geschrieben hat.

License

Apache-2.0. Die OpenAPI-Beschreibung in internal/apiclient/openapi.yaml wird aus der Skycloak-Plattform-API generiert und ist (c) Skycloak; sie ist hier enthalten, damit der Client generiert und verifiziert werden kann. Siehe NOTICE.

Available Tools

141 tools
skycloak_add_cluster_captcha_domainCInspect

Register a hostname for CAPTCHA protection on a cluster.

Inputs: hostname (required), cluster_id (required). Returns: hostname, created_at

skycloak_add_realm_user_to_groupC
Idempotent
Inspect

Add a user to a realm group.

Inputs: realm (required), user_id (required), group_id (required), cluster_id (required). Returns: object

skycloak_assign_application_roleA
Idempotent
Inspect

Grant a role to an application's service account. Provide role_client_id for a client role, or omit it for a realm role.

Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +1 more. Returns: object

skycloak_assign_realm_user_roleC
Idempotent
Inspect

Assign a realm role to a user.

Inputs: realm (required), user_id (required), role_name (required), cluster_id (required). Returns: object

skycloak_cancel_cluster_upgradeA
Destructive
Inspect

Cancel an in-progress cluster version upgrade. Set confirm=true to proceed.

Inputs: confirm (required), cluster_id (required). Returns: object

skycloak_create_applicationAInspect

Create an OIDC/SAML client (application) in a realm. Returns the client secret for confidential clients (store it; it is not retrievable later).

Inputs: name (required), realm (required), client_id (required), cluster_id (required), +4 more. Returns: client_id, client_secret

skycloak_create_application_roleAInspect

Define a new role on an application. This creates the role itself; use skycloak_assign_application_role to grant it to a user.

Inputs: name (required), realm (required), client_id (required), cluster_id (required), +1 more. Returns: id, name, client_id, composite, +2 more

skycloak_create_clusterAInspect

Provision a new Keycloak cluster. Asynchronous: the returned cluster starts in a provisioning state — poll skycloak_get_cluster until its status is 'available'. Requires --allow-writes.

Inputs: name (required), size (required), version (required), location (required), +7 more. Returns: id, url, name, size, +7 more

skycloak_create_domainBInspect

Add a custom domain to a cluster. Returns the DNS records the customer must create to verify and route the domain.

Inputs: domain (required), cluster_id (required), subdomain. Returns: id, domain, is_active, subdomain, +4 more

skycloak_create_domain_routeAInspect

Add a realm route to a custom domain. Never use the master realm; it is reserved for cluster management and the API rejects it.

Inputs: realm (required), domain_id (required), cluster_id (required), hide_realm_path, +1 more. Returns: id, realm, hide_realm_path, allow_admin_access

skycloak_create_exportAInspect

Start a database export for a cluster. Asynchronous: poll skycloak_get_export until the status is 'completed' to obtain the download URL. Including credentials requires an encryption_password.

Inputs: format (required), cluster_id (required), encryption_password, include_credentials. Returns: id, format, status, progress, +6 more

skycloak_create_identity_providerBInspect

Create an OIDC identity provider (SSO connection) in a realm.

Inputs: realm (required), cluster_id (required), provider_id (required), display_name (required), +5 more. Returns: object

skycloak_create_openfga_instanceAInspect

Create an OpenFGA instance bound to one realm of a cluster; a realm has at most one. Asynchronous: it starts in 'provisioning', so poll skycloak_get_openfga_instance until the status is 'ready' or 'failed'. The instance accepts only tokens from that realm that carry the instance's audience. Fails with 403 when the workspace's plan does not include OpenFGA or the workspace reached its instance limit, 409 when the realm already has an instance, and 422 when the realm is 'master', does not exist or is disabled.

Inputs: realm (required), cluster_id (required). Returns: id, realm, issuer, status, +6 more

skycloak_create_realmAInspect

Create a new Keycloak realm in a cluster. Requires the server to be started with --allow-writes and a write-scoped API key.

Inputs: name (required), cluster_id (required), display_name. Returns: name, enabled, cluster_id, cluster_name, +5 more

skycloak_create_realm_exportAInspect

Export a Keycloak realm to an encrypted archive. Asynchronous: poll skycloak_get_realm_export until status is 'completed'. The archive is always encrypted, so encryption_password is required, and the same password is needed to import it again. This is a realm export (one realm's configuration); skycloak_create_export is the separate whole-cluster database export.

Inputs: realm (required), cluster_id (required), encryption_password (required). Returns: id, realm, scope, status, +9 more

skycloak_create_realm_groupBInspect

Create a realm group, optionally nested under a parent group.

Inputs: name (required), realm (required), cluster_id (required), parent_id. Returns: id, name, path

skycloak_create_realm_importAInspect

Import a Keycloak realm into a cluster from an uploaded archive or an existing realm export. Asynchronous: poll skycloak_get_realm_import. Creates a new realm: preflight refuses a name collision rather than overwriting, so an existing realm of the same name fails with 409. It does import users and their credentials, so set confirm=true to proceed.

Inputs: confirm (required), cluster_id (required), password, upload_s3_key, +1 more. Returns: id, realm, status, progress, +7 more

skycloak_create_realm_import_upload_urlAInspect

Get a presigned URL to upload a realm archive to. PUT the archive to upload_url, then pass the returned s3_key to skycloak_create_realm_import as upload_s3_key. Not needed when importing an existing export: pass that export's ID as source_export_id instead.

Inputs: cluster_id (required). Returns: s3_key, upload_url

skycloak_create_realm_roleCInspect

Create a realm-scoped role.

Inputs: name (required), realm (required), cluster_id (required), description. Returns: name, composite, description

skycloak_create_realm_userBInspect

Create a realm user with an initial temporary password.

Inputs: email (required), realm (required), username (required), cluster_id (required), +4 more. Returns: id, email, enabled, username, +3 more

skycloak_create_siem_destinationCInspect

Create a SIEM destination. Credentials are write-only and are not returned.

Inputs: name (required), type (required), source (required), s3, +3 more. Returns: id, s3, http, name, +14 more

skycloak_create_webhook_subscriptionBInspect

Create a webhook subscription. Signing secrets and authorization headers are write-only.

Inputs: url (required), name (required), source (required), event_types (required), +5 more. Returns: id, url, name, source, +8 more

skycloak_delete_applicationA
Destructive
Inspect

Delete an application (OIDC/SAML client) from a realm. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), client_id (required), cluster_id (required). Returns: object

skycloak_delete_application_roleA
Destructive
Inspect

Delete a role from an application. Every user and group holding it loses it. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), client_id (required), role_name (required), +1 more. Returns: object

skycloak_delete_clusterA
Destructive
Inspect

Permanently delete a Keycloak cluster and all of its realms and data. Irreversible. Set confirm=true to proceed.

Inputs: id (required), confirm (required). Returns: object

skycloak_delete_cluster_maintenance_windowA
Destructive
Inspect

Delete a cluster-specific maintenance window so the cluster follows the workspace default. Set confirm=true to proceed.

Inputs: confirm (required), cluster_id (required). Returns: object

skycloak_delete_domainA
Destructive
Inspect

Remove a custom domain from a cluster. Set confirm=true to proceed.

Inputs: confirm (required), domain_id (required), cluster_id (required). Returns: object

skycloak_delete_domain_routeC
Destructive
Inspect

Remove a realm route from a custom domain. Set confirm=true to proceed.

Inputs: confirm (required), route_id (required), domain_id (required), cluster_id (required). Returns: object

skycloak_delete_email_brandingA
Destructive
Inspect

Revert email branding to defaults. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), cluster_id (required). Returns: object

skycloak_delete_exportA
Destructive
Inspect

Delete a database export archive. Set confirm=true to proceed.

Inputs: confirm (required), export_id (required), cluster_id (required). Returns: object

skycloak_delete_extensionB
Destructive
Inspect

Delete a custom extension from the workspace catalog. Set confirm=true to proceed.

Inputs: confirm (required), extension_id (required). Returns: object

skycloak_delete_identity_providerB
Destructive
Inspect

Delete an identity provider from a realm. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), cluster_id (required), provider_id (required). Returns: object

skycloak_delete_login_brandingA
Destructive
Inspect

Revert login branding to defaults. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), cluster_id (required). Returns: object

skycloak_delete_openfga_instanceA
Destructive
Inspect

Permanently delete an OpenFGA instance with its deployment, route and database. The authorization data in it cannot be recovered. Works without OpenFGA access. Removal is asynchronous: the instance shows 'deleting' until it leaves the list. Set confirm=true to proceed.

Inputs: confirm (required), cluster_id (required), instance_id (required). Returns: object

skycloak_delete_realmA
Destructive
Inspect

Permanently delete a realm and all of its users, clients and configuration. This is irreversible. Set confirm=true to proceed.

Inputs: name (required), confirm (required), cluster_id (required). Returns: object

skycloak_delete_realm_groupA
Destructive
Inspect

Delete a realm group. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), group_id (required), cluster_id (required). Returns: object

skycloak_delete_realm_roleB
Destructive
Inspect

Delete a realm role. Set confirm=true to proceed.

Inputs: name (required), realm (required), confirm (required), cluster_id (required). Returns: object

skycloak_delete_realm_userB
Destructive
Inspect

Delete a realm user. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), user_id (required), cluster_id (required). Returns: object

skycloak_delete_siem_destinationA
Destructive
Inspect

Delete a SIEM destination. Set confirm=true to proceed.

Inputs: confirm (required), destination_id (required). Returns: object

skycloak_delete_smtpB
Destructive
Inspect

Remove a realm's SMTP configuration. Set confirm=true to proceed.

Inputs: realm (required), confirm (required), cluster_id (required). Returns: object

skycloak_delete_themeA
Destructive
Inspect

Delete a custom theme. Set confirm=true to proceed. To change an existing theme's files, use skycloak_update_theme_content instead: deleting a theme that is still assigned returns 409, and re-uploading it gives a new ID.

Inputs: confirm (required), theme_id (required), cluster_id (required). Returns: object

skycloak_delete_webhook_subscriptionB
Destructive
Inspect

Delete a webhook subscription. Set confirm=true to proceed.

Inputs: confirm (required), webhook_id (required). Returns: object

skycloak_discover_oidcA
Read-only
Inspect

Resolve an OIDC issuer's discovery document to obtain its authorization, token, and userinfo endpoints. Use the result when creating an identity provider.

Inputs: issuer_url (required). Returns: issuer, jwks_uri, token_endpoint, scopes_supported, +2 more

skycloak_download_theme_contentA
Read-only
Inspect

Download a custom theme's content archive. Returns size and SHA-256 always, and the archive itself only when it is small enough to inline.

Inputs: theme_id (required), cluster_id (required). Returns: sha256, inlined, size_bytes

skycloak_export_cluster_eventsBInspect

Export a cluster's events as a document and return its contents.

Inputs: cluster_id (required). Returns: document

skycloak_get_applicationA
Read-only
Inspect

Get an application (OIDC/SAML client) by client ID.

Inputs: realm (required), client_id (required), cluster_id (required). Returns: Name, Type, Status, ClientID, +1 more

skycloak_get_application_roleA
Read-only
Inspect

Get one role defined on an application, with its description and Keycloak identifiers.

Inputs: realm (required), client_id (required), role_name (required), cluster_id (required). Returns: id, name, client_id, composite, +2 more

skycloak_get_client_theme_assignmentB
Read-only
Inspect

Get a client's login-theme override (empty means the realm default).

Inputs: realm (required), client_id (required), cluster_id (required). Returns: login

skycloak_get_clusterB
Read-only
Inspect

Get full details for a single Keycloak cluster by its ID.

Inputs: id (required). Returns: id, url, name, size, +7 more

skycloak_get_cluster_credentialsA
Read-only
Inspect

Get a cluster's Keycloak automation client credentials for OAuth2 client_credentials. Needs a key with the clusters:credentials:read scope, which is not granted by default.

Inputs: cluster_id (required). Returns: client_id, token_url, client_secret

skycloak_get_cluster_insightsB
Read-only
Inspect

Get cluster analytics as a JSON document. type is one of: overview, authentication, events, performance, security.

Inputs: cluster_id (required), type. Returns: json

skycloak_get_cluster_maintenance_windowA
Read-only
Inspect

Get a cluster-specific maintenance window. A 404 means the cluster follows the workspace default.

Inputs: cluster_id (required). Returns: enabled, timezone, end_local, start_local, +1 more

skycloak_get_cluster_securityA
Read-only
Inspect

Get a cluster's edge-security configuration: IP allow-listing, rate limiting, WAF, geo-blocking, and bot management.

Inputs: cluster_id (required). Returns: waf, geo_blocking, rate_limiting, bot_management, +1 more

skycloak_get_cluster_upgrade_pathB
Read-only
Inspect

Get the recommended version-upgrade path for a cluster.

Inputs: cluster_id (required). Returns: steps

skycloak_get_domainB
Read-only
Inspect

Get a custom domain by ID, including its DNS records and verification/SSL status.

Inputs: domain_id (required), cluster_id (required). Returns: id, domain, is_active, subdomain, +4 more

skycloak_get_domain_routeC
Read-only
Inspect

Get a single realm route on a custom domain.

Inputs: route_id (required), domain_id (required), cluster_id (required). Returns: id, realm, hide_realm_path, allow_admin_access

skycloak_get_email_brandingA
Read-only
Inspect

Get the email-template branding (colors, logo, footer) for a realm.

Inputs: realm (required), cluster_id (required). Returns: status, primary_color, footer_company_name, header_logo_light_url

skycloak_get_exportA
Read-only
Inspect

Get a database export job by ID, including its status, progress, and (once completed) the time-limited download URL.

Inputs: export_id (required), cluster_id (required). Returns: id, format, status, progress, +6 more

skycloak_get_identity_providerC
Read-only
Inspect

Get an identity provider by provider ID.

Inputs: realm (required), cluster_id (required), provider_id (required). Returns: Type, Enabled, ProviderID, DisplayName

skycloak_get_login_brandingB
Read-only
Inspect

Get the login-page branding (colors, logo, toggles) for a realm.

Inputs: realm (required), cluster_id (required). Returns: status, logo_url, primary_color, background_color, +2 more

skycloak_get_logsA
Read-only
Inspect

Read recent Keycloak server logs for a cluster, optionally filtered by level and a search string.

Inputs: cluster_id (required), level, limit, search. Returns: logs, count

skycloak_get_openfga_instanceA
Read-only
Inspect

Get one OpenFGA instance of a cluster, including its status and the API URL, token issuer and audience to call it with.

Inputs: cluster_id (required), instance_id (required). Returns: id, realm, issuer, status, +6 more

skycloak_get_realmC
Read-only
Inspect

Get a realm by name.

Inputs: realm (required), cluster_id (required). Returns: id, name, enabled, display_name, +6 more

skycloak_get_realm_exportA
Read-only
Inspect

Get a realm export job by ID. Poll this after skycloak_create_realm_export until status is 'completed'; the download URL only appears then and expires 24 hours later.

Inputs: export_id (required). Returns: id, realm, scope, status, +9 more

skycloak_get_realm_groupC
Read-only
Inspect

Get a realm group by ID.

Inputs: realm (required), group_id (required), cluster_id (required). Returns: id, name, path

skycloak_get_realm_importA
Read-only
Inspect

Get a realm import job by ID. Poll this after skycloak_create_realm_import until status is 'completed' or 'failed'.

Inputs: import_id (required). Returns: id, realm, status, progress, +7 more

skycloak_get_realm_roleC
Read-only
Inspect

Get a realm role by name.

Inputs: name (required), realm (required), cluster_id (required). Returns: name, composite, description

skycloak_get_realm_userB
Read-only
Inspect

Get a realm user by ID.

Inputs: realm (required), user_id (required), cluster_id (required). Returns: id, email, enabled, username, +3 more

skycloak_get_security_logsB
Read-only
Inspect

Read recent security (WAF) logs for a cluster — blocked requests, attack types, source IPs.

Inputs: cluster_id (required), limit, search. Returns: logs, count

skycloak_get_siem_destinationB
Read-only
Inspect

Get a SIEM destination by ID.

Inputs: destination_id (required). Returns: id, s3, http, name, +14 more

skycloak_get_smtpA
Read-only
Inspect

Get a realm's SMTP configuration (secret values are never returned).

Inputs: realm (required), cluster_id (required). Returns: host, port, status, auth_type, +4 more

skycloak_get_themeA
Read-only
Inspect

Get a custom theme by ID. restart_required is true when the theme's content was replaced under its exact name (see skycloak_get_theme_settings) and Keycloak has not restarted since, so the previous content may still be live; use skycloak_restart_cluster_instances to apply it.

Inputs: theme_id (required), cluster_id (required). Returns: id, name, status, version, +3 more

skycloak_get_theme_assignmentA
Read-only
Inspect

Get the active custom theme per Keycloak theme type (login, account, admin, email) for a realm.

Inputs: realm (required), cluster_id (required). Returns: admin, email, login, account

skycloak_get_theme_settingsA
Read-only
Inspect

Get the workspace's theme naming policy: whether exact_theme_names is on. When on, every theme in the workspace is served from a folder named exactly like the theme, and that name never changes across content replaces. When off (the default), the served folder changes on each content replace, unless the theme was created by a platform migration.

Returns: exact_theme_names

skycloak_get_webhook_subscriptionB
Read-only
Inspect

Get a webhook subscription by ID.

Inputs: webhook_id (required). Returns: id, url, name, source, +8 more

skycloak_install_extensionAInspect

Install a catalog extension on a cluster. Installation is asynchronous; poll skycloak_list_cluster_extensions until the status settles. Provide required parameters keyed by parameter name.

Inputs: cluster_id (required), extension_id (required), parameters. Returns: source, status, extension_id, extension_name, +3 more

skycloak_list_application_rolesC
Read-only
Inspect

List the roles assigned to an application's service account.

Inputs: realm (required), client_id (required), cluster_id (required). Returns: count, roles

skycloak_list_applicationsB
Read-only
Inspect

List the OIDC/SAML clients (applications) in a realm.

Inputs: realm (required), cluster_id (required). Returns: count, applications

skycloak_list_application_sessionsA
Read-only
Inspect

List active user sessions for an application.

Inputs: realm (required), client_id (required), cluster_id (required). Returns: count, sessions

skycloak_list_cluster_captcha_domainsB
Read-only
Inspect

List hostnames registered for CAPTCHA protection on a cluster.

Inputs: cluster_id (required). Returns: count, domains, max_allowed

skycloak_list_cluster_extensionsA
Read-only
Inspect

List the extensions currently installed on a cluster, with their installed version, the version available for the cluster's Keycloak, and upgrade status.

Inputs: cluster_id (required). Returns: count, extensions

skycloak_list_cluster_featuresA
Read-only
Inspect

List the Keycloak feature flags available to tenant clusters.

Returns: features

skycloak_list_cluster_locationsA
Read-only
Inspect

List the deployment regions available to the workspace.

Returns: locations

skycloak_list_clustersA
Read-only
Inspect

List the Keycloak clusters in your Skycloak workspace, with their status, type, size, version and location.

Inputs: limit, offset. Returns: count, clusters

skycloak_list_cluster_typesA
Read-only
Inspect

List the cluster types the workspace can provision.

Returns: types

skycloak_list_cluster_upgradesB
Read-only
Inspect

List the version-upgrade history for a cluster.

Inputs: cluster_id (required). Returns: upgrades

skycloak_list_cluster_versionsC
Read-only
Inspect

List the Keycloak versions available for a cluster type.

Inputs: type (required). Returns: versions

skycloak_list_domain_routesC
Read-only
Inspect

List the realm routes configured on a custom domain.

Inputs: domain_id (required), cluster_id (required). Returns: routes

skycloak_list_domainsB
Read-only
Inspect

List the custom domains configured on a cluster.

Inputs: cluster_id (required). Returns: count, domains

skycloak_list_exportsA
Read-only
Inspect

List the database export jobs for a cluster, with their status and expiry.

Inputs: cluster_id (required). Returns: count, exports

skycloak_list_extensionsA
Read-only
Inspect

List the extension catalog available to the workspace (marketplace extensions that can be installed on a cluster).

Returns: count, extensions

skycloak_list_identity_providersA
Read-only
Inspect

List the identity providers (SSO connections) in a realm. Omit realm to cover every realm, and cluster_id to cover every cluster, so one call can answer an SSO question across the whole fleet.

Inputs: realm, cluster_id. Returns: count, unreachable, identity_providers

skycloak_list_identity_provider_templatesA
Read-only
Inspect

List the pre-configured identity-provider templates. Use a template id when creating a provider.

Returns: templates

skycloak_list_openfga_instancesA
Read-only
Inspect

List the OpenFGA instances bound to a cluster's realms, with each one's status (provisioning, ready, failed or deleting). Works on every plan, so a workspace that lost OpenFGA access still sees what it has.

Inputs: cluster_id (required). Returns: count, instances

skycloak_list_realm_group_membersA
Read-only
Inspect

List the users that belong to a realm group.

Inputs: realm (required), group_id (required), cluster_id (required). Returns: count, users

skycloak_list_realm_groupsB
Read-only
Inspect

List the top-level groups in a realm.

Inputs: realm (required), cluster_id (required). Returns: count, groups

skycloak_list_realm_rolesC
Read-only
Inspect

List the realm-scoped roles in a realm.

Inputs: realm (required), cluster_id (required). Returns: count, roles

skycloak_list_realmsA
Read-only
Inspect

List the Keycloak realms in a Skycloak cluster.

Inputs: cluster_id. Returns: count, realms, unreachable

skycloak_list_realm_usersC
Read-only
Inspect

List the users in a realm.

Inputs: realm (required), cluster_id (required). Returns: count, users

skycloak_list_siem_destinationsA
Read-only
Inspect

List SIEM destinations configured for the workspace.

Returns: count, destinations

skycloak_list_themesA
Read-only
Inspect

List the custom themes uploaded to a cluster, with their IDs, status, and theme types. restart_required is true on a theme whose replaced content is not live yet; see skycloak_get_theme_settings and skycloak_restart_cluster_instances.

Inputs: cluster_id (required). Returns: count, themes

skycloak_list_user_groupsC
Read-only
Inspect

List the groups a user belongs to.

Inputs: realm (required), user_id (required), cluster_id (required). Returns: count, groups

skycloak_list_user_rolesA
Read-only
Inspect

List the realm roles assigned to a user.

Inputs: realm (required), user_id (required), cluster_id (required). Returns: count, roles

skycloak_list_webhook_event_typesB
Read-only
Inspect

List webhook event types. Optionally filter by source: platform or keycloak.

Inputs: source. Returns: count, event_types

skycloak_list_webhook_subscriptionsA
Read-only
Inspect

List webhook subscriptions. Optionally filter by source, cluster_id, and enabled.

Inputs: source, enabled, cluster_id. Returns: count, subscriptions

skycloak_query_eventsA
Read-only
Inspect

Query Keycloak user and admin events for a cluster (logins, token grants, admin operations). Filter user events with types/error, admin events with operation_types, and either with realm, start_time/end_time, and offset. Note search only matches username, client_id, realm_name and ip_address; it does not match the event type, so use types or operation_types for that. Limit is capped at 100 per call, so page with offset for anything larger.

Inputs: cluster_id (required), error, limit, order, +9 more. Returns: count, events

skycloak_remove_application_roleB
DestructiveIdempotent
Inspect

Remove a role from an application's service account.

Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +1 more. Returns: object

skycloak_remove_cluster_captcha_domainA
Destructive
Inspect

Remove a hostname from CAPTCHA protection on a cluster. Set confirm=true to proceed.

Inputs: confirm (required), hostname (required), cluster_id (required). Returns: object

skycloak_remove_realm_user_from_groupC
DestructiveIdempotent
Inspect

Remove a user from a realm group.

Inputs: realm (required), user_id (required), group_id (required), cluster_id (required). Returns: object

skycloak_remove_realm_user_roleC
DestructiveIdempotent
Inspect

Remove a realm role from a user.

Inputs: realm (required), user_id (required), role_name (required), cluster_id (required). Returns: object

skycloak_restart_cluster_instancesA
Destructive
Inspect

Restart a cluster's Keycloak instances, disrupting live traffic on it. Use this after skycloak_update_theme_settings turns exact_theme_names on: a theme whose content was replaced under its exact name only serves the new content once Keycloak restarts (see restart_required on skycloak_get_theme / skycloak_list_themes). Applies immediately unless the workspace latches disruptive changes to the maintenance window, in which case the result reports deferred=true and, when known, next_window (RFC3339). Returns a conflict when the cluster cannot restart right now: already busy with a restart or other update, not in an available state, or the operator has no environment variable slot left. Set confirm=true to proceed.

Inputs: confirm (required), cluster_id (required). Returns: impact, deferred, next_window

skycloak_rotate_application_secretB
Destructive
Inspect

Regenerate an application's client secret and return the new value (shown only once).

Inputs: realm (required), client_id (required), cluster_id (required). Returns: client_secret

skycloak_set_client_theme_assignmentA
Idempotent
Inspect

Set a client's login-theme override. Pass a theme ID, or an empty string to reset to the realm default.

Inputs: realm (required), client_id (required), cluster_id (required), login. Returns: login

skycloak_set_cluster_maintenance_windowB
Idempotent
Inspect

Create or replace a cluster-specific maintenance window.

Inputs: enabled (required), timezone (required), end_local (required), cluster_id (required), +2 more. Returns: enabled, timezone, end_local, start_local, +1 more

skycloak_set_theme_assignmentA
Idempotent
Inspect

Assign custom themes to a realm per Keycloak theme type. Pass a theme ID to activate it, or an empty string to reset that type to Keycloak's built-in default. Only the provided fields are changed.

Inputs: realm (required), cluster_id (required), admin, email, +2 more. Returns: admin, email, login, account

skycloak_test_identity_providerAInspect

Test connectivity to an identity provider, optionally overriding the client credentials for this test only.

Inputs: realm (required), cluster_id (required), provider_id (required), client_id, +1 more. Returns: message, success

skycloak_test_siem_destinationBInspect

Send a test event to a SIEM destination.

Inputs: destination_id (required). Returns: message, success

skycloak_test_smtpBInspect

Send a test email through a realm's configured SMTP server to verify delivery.

Inputs: email (required), realm (required), cluster_id (required). Returns: message, success

skycloak_test_webhook_subscriptionCInspect

Send a test event to a webhook subscription.

Inputs: webhook_id (required), event_type. Returns: success, delivery_id, duration_ms, attempted_at, +3 more

skycloak_uninstall_extensionA
Destructive
Inspect

Uninstall an extension from a cluster. Set confirm=true to proceed.

Inputs: confirm (required), cluster_id (required), extension_id (required). Returns: object

skycloak_update_applicationC
Idempotent
Inspect

Update an application's name, description, or redirect URIs.

Inputs: realm (required), client_id (required), cluster_id (required), name, +2 more. Returns: Name, Type, Status, ClientID, +1 more

skycloak_update_application_roleA
Idempotent
Inspect

Rename an application role or change its description. Fields you omit keep their current value.

Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +2 more. Returns: id, name, client_id, composite, +2 more

skycloak_update_clusterA
Idempotent
Inspect

Update a cluster's version (to trigger an upgrade) or size.

Inputs: cluster_id (required), size, version, auto_upgrade_enabled. Returns: ID, URL, Name, Size, +7 more

skycloak_update_cluster_securityA
Idempotent
Inspect

Update a cluster's edge-security configuration. Only the sections you provide are changed; CAPTCHA settings are preserved. Supports IP allow-listing, rate limiting, WAF, geo-blocking, and bot management.

Inputs: cluster_id (required), waf, geo_blocking, rate_limiting, +2 more. Returns: waf, geo_blocking, rate_limiting, bot_management, +1 more

skycloak_update_domain_routeB
Idempotent
Inspect

Update a domain route's admin access and CORS origins.

Inputs: route_id (required), domain_id (required), cluster_id (required), allow_admin_access, +1 more. Returns: id, realm, hide_realm_path, allow_admin_access

skycloak_update_extensionB
Idempotent
Inspect

Update a custom extension's name or description.

Inputs: extension_id (required), name, description. Returns: id, name, source, version, +3 more

skycloak_update_identity_providerB
Idempotent
Inspect

Update an identity provider's display name and enabled state.

Inputs: realm (required), cluster_id (required), provider_id (required), enabled, +1 more. Returns: Type, Enabled, ProviderID, DisplayName

skycloak_update_realmB
Idempotent
Inspect

Update a realm's display name and enabled state.

Inputs: realm (required), cluster_id (required), enabled, display_name. Returns: id, name, enabled, display_name, +6 more

skycloak_update_realm_groupC
Idempotent
Inspect

Rename a realm group.

Inputs: name (required), realm (required), group_id (required), cluster_id (required). Returns: id, name, path

skycloak_update_realm_roleB
Idempotent
Inspect

Rename a realm role or change its description.

Inputs: name (required), realm (required), cluster_id (required), new_name, +1 more. Returns: name, composite, description

skycloak_update_realm_userB
Idempotent
Inspect

Update a realm user's profile (email, name, enabled, email_verified).

Inputs: realm (required), user_id (required), cluster_id (required), email, +4 more. Returns: id, email, enabled, username, +3 more

skycloak_update_siem_destinationB
Idempotent
Inspect

Update a SIEM destination. Only provided fields are changed; credentials remain write-only.

Inputs: destination_id (required), s3, http, name, +4 more. Returns: id, s3, http, name, +14 more

skycloak_update_themeA
Idempotent
Inspect

Update a theme's name, description, or version. Metadata only: use skycloak_update_theme_content to replace the theme's archive.

Inputs: theme_id (required), cluster_id (required), name, version, +1 more. Returns: id, name, status, version, +3 more

skycloak_update_theme_contentA
DestructiveIdempotent
Inspect

Replace an existing theme's archive with a new one, in place. The theme keeps its ID, its name and every realm and application assignment, and the new content deploys immediately, so this is the way to edit a theme: deleting and re-uploading detaches it and leaves the sign-in page unbranded in between. Pass the ZIP or Keycloakify JAR base64-encoded in content_base64. Set confirm=true to proceed: the archive being replaced is not recoverable afterwards. The replacement must still contain every theme type the theme provides today, or the API rejects it; a theme created by a platform migration has pinned content and answers 409. When the workspace has exact_theme_names on (see skycloak_get_theme_settings), this sets restart_required=true on the theme until skycloak_restart_cluster_instances applies it.

Inputs: confirm (required), theme_id (required), cluster_id (required), content_base64 (required), +2 more. Returns: id, name, status, version, +3 more

skycloak_update_theme_settingsA
DestructiveIdempotent
Inspect

Turn the workspace's exact_theme_names policy on or off. The caller's API key must have been minted for a workspace owner or admin; any other role, including a cluster admin, gets 403 even with themes:write. Turning it on moves every existing theme in the workspace to its exact served name in the background, not blocking this call; a theme that cannot move right away (its cluster is busy updating, say) moves on its next content replace instead. Turning it off changes nothing immediately: each theme keeps its current served folder until its next content replace, after which the folder changes on every replace again. A theme replaced under its exact name sets restart_required=true on skycloak_get_theme and skycloak_list_themes until Keycloak restarts; use skycloak_restart_cluster_instances to apply it. Set confirm=true to proceed.

Inputs: confirm (required), exact_theme_names (required). Returns: exact_theme_names

skycloak_update_webhook_subscriptionC
Idempotent
Inspect

Update a webhook subscription. Use clear_authorization_header, clear_cluster_id, or clear_realm_id to remove nullable fields.

Inputs: webhook_id (required), url, name, source, +9 more. Returns: id, url, name, source, +8 more

skycloak_upgrade_extensionA
Idempotent
Inspect

Upgrade an installed extension to the latest available version. Asynchronous.

Inputs: cluster_id (required), extension_id (required). Returns: source, status, extension_id, extension_name, +3 more

skycloak_upsert_email_brandingA
Idempotent
Inspect

Create or update email-template branding: color, light and dark logos, company URL and footer text. Fields you omit keep their current value.

Inputs: realm (required), cluster_id (required), company_url, footer_text, +4 more. Returns: status, primary_color, footer_company_name, header_logo_light_url

skycloak_upsert_login_brandingA
Idempotent
Inspect

Create or update login-page branding: colors, logo, favicon, font, terms and privacy links, the registration, remember-me, forgot-password and Powered by Skycloak toggles. Fields you omit keep their current value.

Inputs: realm (required), cluster_id (required), font_url, logo_url, +9 more. Returns: status, logo_url, primary_color, background_color, +2 more

skycloak_upsert_smtpB
Idempotent
Inspect

Create or update a realm's SMTP configuration (basic auth).

Inputs: host (required), port (required), realm (required), cluster_id (required), +5 more. Returns: host, port, status, auth_type, +4 more

skycloak_verify_domainB
Idempotent
Inspect

Trigger DNS verification for a custom domain and return its updated status.

Inputs: domain_id (required), cluster_id (required). Returns: id, domain, is_active, subdomain, +4 more

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.2/5.0

    Scored across 141 tools

    Disambiguation3/5

    The tool set covers many distinct Keycloak resources, and most descriptions explicitly distinguish similar operations (e.g. cluster export vs realm export). However, with 141 tools there are several clusters of near-neighbors—theme metadata vs theme content vs theme assignment, cluster logs vs security logs vs event queries, and multiple role-listing tools—that an agent could easily misselect without careful reading.

    Naming Consistency5/5

    Every tool uses the same skycloak_ prefix and snake_case verb_noun convention, such as skycloak_create_realm, skycloak_list_realm_users, and skycloak_delete_webhook_subscription. Verb choices vary semantically (create/update/upsert/add/remove), but the overall pattern is highly predictable.

    Tool Count1/5

    141 tools is far beyond a practical surface for an agent, even for a broad Keycloak management platform. The domain is large, but this count creates excessive selection burden and strongly suggests many operations should be consolidated or grouped.

    Completeness4/5

    Coverage is extensive across clusters, realms, users, groups, roles, applications, identity providers, domains, branding, themes, extensions, webhooks, SIEM, OpenFGA, exports/imports, SMTP, security, and observability. Minor gaps remain, such as user credential/password reset operations, group-role assignment, and session revocation, but core lifecycle workflows are well represented.

    Maintenance

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      D
      maintenance
      MCP server for interacting with Keyshade's secrets management platform, enabling secure retrieval and management of secrets via natural language.
      44
      9
      Mozilla Public 2.0
    • A
      license
      Not graded
      quality
      B
      maintenance
      MCP server for Authentik identity management, enabling natural language management of users, groups, applications, flows, policies, providers, and more.
      116 npm
      16
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      A Model Context Protocol (MCP) server that provides a natural language interface for managing Keycloak identity and access management through its REST API.
      MIT
    • A
      license
      Not graded
      quality
      B
      maintenance
      MCP server for managing Ory Kratos identities, sessions, and authentication flows, enabling AI assistants to perform identity management tasks via natural language.
      13 npm
      1
      MIT