skycloak-mcp
skycloak-mcp
Skycloak(托管式 Keycloak)的官方 Model Context Protocol 服务器:从任意 MCP 客户端(Claude Desktop、Claude Code、Cursor)管理你的集群、领域、应用和单点登录。
状态: 早期发布版本。工具覆盖范围正在扩展;请参阅变更日志了解当前可用功能。
快速开始
claude mcp add --transport http skycloak https://mcp.skycloak.io无需 API 密钥、客户端 ID 或配置。你的浏览器会自动打开,登录 Skycloak,工具便会显示。任何支持流式 HTTP 的 MCP 客户端都以相同方式工作:只需提供 URL,无需其他操作。
然后可以提出例如:
“我的哪些 Keycloak 集群升级滞后了?”
“在 EU 集群上创建一个支持 Google 和 GitHub 登录的暂存领域。”
“上周谁被添加到了生产领域?”
“设置一个 SIEM 目标,将管理事件转发到我们的 Datadog Webhook。”
Related MCP server: MCP Authentik
认证与安全性
托管 HTTP + OAuth(无需配置凭据)。 将客户端指向
https://mcp.skycloak.io,不带任何请求头。服务器在/.well-known/oauth-protected-resource位置返回401,并附上指向其 RFC 9728 元数据的指针;客户端针对 Skycloak 登录领域运行浏览器授权码流程,获得的访问令牌被交换为一个短期有效、作用域限定于工作空间的 API 密钥,本次会话将使用该密钥。密钥有效期为一小时,并会自动续期。客户端配置中不会存储任何内容。托管 HTTP + API 密钥。 在 Skycloak 仪表盘 中创建一个密钥,然后以
Authorization: Bearer <key>(或API-Key: <key>)的形式发送。每个请求自带凭据,且仅作用于该凭据所属的工作空间。服务器不维护会话状态,因此一个请求不会继承另一个调用者的权限。密钥在连接时不会验证:Skycloak API 是权威依据,无效密钥会在首次工具调用时返回401,而非连接时。工具匹配你的角色。 通过 OAuth 连接时,工具列表会根据会话作用域进行裁剪,因此只读工作空间成员不会看到会返回
403的写入工具。使用 API 密钥时,整个工具集都会注册,因为密钥的作用域对服务器不可见,未授权的调用会在 API 层面返回403。本地 stdio。 运行
skycloak-mcp init,在浏览器中批准(OAuth 2.0 设备授权流程)。它会生成一个工作空间作用域的 API 密钥,存储在你的操作系统密钥链中,并自动检测你的默认工作空间(通过--workspace <id>可指定其他工作空间)。skycloak-mcp logout会删除已存储的密钥。无头 / CI 环境。 设置环境变量
SKYCLOAK_API_KEY(在 Skycloak 仪表盘 中创建密钥)可完全跳过浏览器流程。该环境变量始终优先于密钥链。写入操作由你的凭据控制,而非标志位。
https://mcp.skycloak.io上的托管服务器支持写入能力,你能实际修改的内容受限于密钥的作用域和工作空间角色:只读成员无论工具列表如何,都无法进行任何变更。在 URL 后添加?readonly=true可强制会话使用只读工具面。本地二进制文件则相反,除非使用--allow-writes启动,否则不会注册任何写入工具。集群凭据需主动授权。
get_cluster_credentials会返回集群的 Keycloak 管理员凭据,持有该密钥的助手将能看到这些凭据,因此init默认不请求此作用域。使用携带该作用域的密钥:在仪表盘中创建,或通过 stdio 登录时使用skycloak-mcp init --allow-credentials。若无此作用域,该工具会返回一个 403 错误,并说明两种获取路径。破坏性工具需确认: 例如删除领域,需要显式提供
confirm=true参数。请求会根据你的 Skycloak 套餐进行速率限制;收到
429响应时,服务器会返回Retry-After头部。
工具
共 129 个工具:58 个只读,71 个写入。只读工具始终可用。在托管服务器上,写入工具也会注册,但受凭据作用域限制;本地二进制文件仅在使用 --allow-writes 启动时注册写入工具。
工具名称带有 skycloak_ 前缀,下表已省略,因此 list_clusters 在客户端中实际为 skycloak_list_clusters。
区域 | 只读 | 写入 ( |
集群 |
|
|
边缘安全 |
|
|
领域 |
|
|
应用 |
|
|
身份提供商 |
|
|
用户、角色与组 |
|
|
自定义域名 |
|
|
品牌与主题 |
|
|
扩展 |
|
|
SMTP |
|
|
导出与日志 |
|
|
领域导入与导出 |
|
|
SIEM |
|
|
Webhooks |
|
|
约定: 破坏性工具(delete_*、uninstall_extension、cancel_cluster_upgrade)需要 confirm=true。create_cluster 是异步的:轮询 get_cluster 直到集群状态变为 available。create_domain 返回客户必须创建的 DNS 记录;verify_domain 触发 DNS 检查。set_theme_assignment 根据 Keycloak 主题类型激活自定义主题(空字符串重置为内置默认主题)。update_cluster_security 不会修改 CAPTCHA 设置。领域导入/导出移动单个领域的配置,与 create_export(导出整个集群数据库)不同:两者都是异步的,且领域归档始终加密,因此导出时使用的密码在重新导入时是必需的。领域可以直接从现有导出(source_export_id)导入,也可以从上传的归档(create_realm_import_upload_url、PUT、然后 upload_s3_key)导入;导入会创建一个新领域,并在名称冲突时拒绝操作而非覆盖,且需要 confirm=true,因为它会同时导入用户和凭据。
连接
对于托管的 HTTP,最简单的路由是 OAuth,它根本不需要凭据:
claude mcp add --transport http skycloak https://mcp.skycloak.io首次调用会打开您的浏览器,您在 Skycloak 登录页面中批准,然后工具就会出现。如果您属于多个工作区,请指定您想要的那个:
claude mcp add --transport http skycloak "https://mcp.skycloak.io?workspace=<workspace-id>"否则,在 Skycloak 仪表板中创建一个 API 密钥,并配置您的 MCP 客户端将其作为 bearer 令牌发送:
claude mcp add --transport http skycloak https://mcp.skycloak.io --header "Authorization: Bearer sk_sc_XXX"这会将以下内容添加到 .claude.json:
{
"mcpServers": {
"skycloak": {
"type": "http",
"url": "https://mcp.skycloak.io",
"headers": {
"Authorization": "Bearer sk_sc_XXX"
}
}
}
}对于本地 stdio,登录一次,然后将您的客户端指向 skycloak-mcp run:
skycloak-mcp init # one-time browser sign-in; stores a key in your keychainClaude Desktop / Cursor(本地,stdio):
{
"mcpServers": {
"skycloak": {
"command": "skycloak-mcp",
"args": ["run", "--transport", "stdio"]
}
}
}Claude Code:
claude mcp add skycloak -- skycloak-mcp run --transport stdio对于无头/CI 环境(无浏览器),跳过 init 并直接传递密钥:将 "env": { "SKYCLOAK_API_KEY": "sk_sc_..." } 添加到配置中,或使用 claude mcp add skycloak --env SKYCLOAK_API_KEY=sk_sc_... -- skycloak-mcp run --transport stdio。
仅当您打算进行更改时才添加 --allow-writes(使用 skycloak-mcp init --allow-writes 登录,或使用具有写入权限的密钥)。
在托管的 HTTP URL 中添加 ?readonly=true 以仅暴露该 HTTP 会话的只读工具,或添加 ?readonly=false 以请求具有写入能力的工具界面。查询参数默认为 false,但仅当服务器以 --allow-writes 启动时才会注册写入工具。
添加 ?workspace=<uuid> 来选择 OAuth 会话作用于哪个工作区。仅当您属于多个工作区时才需要;如果只有一个工作区,服务器会自动为您选择;如果您属于多个工作区且未指定,则连接会失败,并显示一条消息列出它们。
运行 HTTP 传输
skycloak-mcp run --transport http --http-addr :8080它不需要自己的凭据:调用者按请求提供自己的凭据,因此无需在部署时注入任何内容。GET /healthz 和 GET /readyz 未经身份验证,仅报告进程已启动;它们故意不探测 Skycloak API,因此上游故障不会同时导致所有副本的探测失败。服务器不保存会话状态,因此副本不需要会话亲和性,可以自由扩展或滚动更新。SIGTERM 会停止新连接并排空正在进行的调用。
只要设置了 SKYCLOAK_ISSUER 和 SKYCLOAK_DASHBOARD_URL(默认情况下已设置),OAuth 路径就会启用。此时 GET /.well-known/oauth-protected-resource 会以未经身份验证的方式提供,将领域命名为授权服务器。其 resource 值在设置 SKYCLOAK_PUBLIC_URL 时取自该变量,否则取自请求自身的 Host 和 scheme,因此位于入口后面的单主机部署无需额外配置。Scheme 来自 X-Forwarded-Proto(如果存在),否则对于非回环主机默认为 https,因为 TLS 在上游终止,发布 http:// 标识符不会匹配客户端连接的 URL。如果您的入口重写了 Host,请设置 SKYCLOAK_PUBLIC_URL。该文档还列出 openid profile email 作为其 scopes_supported,并且 WWW-Authenticate 质询将其作为 scope 参数重复,因此读取任一参数的客户端会向领域请求这些参数:openid 是必需的,因为令牌交换使仪表板调用 Keycloak 的用户信息端点,而 Keycloak 会拒绝没有该作用域的令牌。如果令牌到达时没有该作用域,验证时会返回 401 和质询,而不是将其带到无法成功的交换中,因此仍然持有旧授权令牌的客户端会停止重试并重新登录。清空发行者或仪表板变量中的任何一个都会完全关闭 OAuth,服务器将恢复为仅质询 API 密钥,不再有其他操作。
启动时会记录一行,显示已解析的配置(oauth=、issuer=、dashboard=、public_url=、endpoint=、allow_writes=),因此无需重新部署即可发现配置错误的部署。每次请求在 OAuth 路径上被拒绝时,都会记录一行,说明失败的阶段(verify、exchange 或 scopes)、调用者收到的状态以及底层错误。验证失败会添加拒绝令牌的检查(expired、wrong_issuer、bad_signature、unknown_key_id、wrong_token_type、no_openid_scope 等);交换失败会添加仪表板的状态和调用的主机。调用者在令牌验证后显示为令牌的主体,而绝不会作为凭据显示:访问令牌、Authorization 标头以及生成的 API 密钥永远不会被记录。
配置
环境变量 | 默认值 |
| 无(stdio 可选;HTTP 客户端改为提供 |
|
|
| 当前 API 版本 |
|
|
|
|
|
|
| 无(从每个请求中派生;当入口重写 |
命令:init(浏览器登录)、run(提供服务)、logout(删除存储的密钥)。init 接受 --workspace <id>、--allow-writes、--allow-credentials 和 --ttl-days(默认为 90)。
标志 | 默认值 | 描述 |
|
|
|
|
| HTTP 传输的监听地址 |
|
| 为 stdio 启用可变工具,并允许 |
开发
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 specinternal/apiclient 下的 API 客户端是从 Skycloak OpenAPI 规范使用 oapi-codegen 生成的。
与 API 保持同步
internal/apiclient 中的客户端是从 internal/apiclient/openapi.yaml 使用 oapi-codegen 生成的;运行 make generate 来刷新它。如果提交的生成代码与规范偏离,CI 会失败。请求会在 429/5xx 时重试,并带有 Retry-After 感知的退避。
分发
在每个标签上以 GitHub 二进制文件和 ghcr.io/sky-cloak/skycloak-mcp 容器镜像形式发布,并发布到 MCP Registry 作为 io.skycloak/skycloak-mcp。大多数人两者都不需要:托管的服务器无需安装。
安全
请私下报告漏洞。参见 SECURITY.md。
贡献者
由 Skycloak 的 Guilliano Molaire、Neville Omangi 和 Aphilas 构建。仓库历史在开源时被压缩,因此提交日志不反映谁的贡献。
许可证
Apache-2.0。internal/apiclient/openapi.yaml 中的 OpenAPI 描述是从 Skycloak 平台 API 生成的,版权归 Skycloak 所有;此处包含它以便生成和验证客户端。参见 NOTICE。
Available Tools
141 toolsskycloak_add_cluster_captcha_domainAInspect
Register one hostname for CAPTCHA protection on a cluster, so sign-in requests to it can be challenged. There is a per-workspace maximum, reported by skycloak_list_cluster_captcha_domains. The rest of the edge-security configuration is untouched.
Inputs: hostname (required), cluster_id (required). Returns: hostname, created_at
skycloak_add_realm_user_to_groupAIdempotentInspect
Add one realm user to one realm group, so the user picks up whatever the group carries. Needs user_id from skycloak_list_realm_users and group_id from skycloak_list_realm_groups. Adding an existing member changes nothing.
Inputs: realm (required), user_id (required), group_id (required), cluster_id (required). Returns: object
skycloak_assign_application_roleAIdempotentInspect
Grant a role to one application's service account, so the client itself holds it when it uses client_credentials. The principal is the application, not a person: for a human user use skycloak_assign_realm_user_role. Pass role_client_id for a role defined on a client, or omit it for a realm role. The application must have the client_credentials grant enabled.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +1 more. Returns: object
skycloak_assign_realm_user_roleAIdempotentInspect
Grant a realm role to a realm user, identified by user_id from skycloak_list_realm_users. The principal is a user and the role is realm-scoped: a client role cannot be granted here, and for an application's service account use skycloak_assign_application_role. Granting an existing role again changes nothing.
Inputs: realm (required), user_id (required), role_name (required), cluster_id (required). Returns: object
skycloak_cancel_cluster_upgradeADestructiveInspect
Cancel the Keycloak version upgrade currently running on one cluster. Stopping an upgrade part-way can leave the cluster mid-migration, so check skycloak_get_cluster for the version it ended on and skycloak_list_cluster_upgrades for the recorded phase. Set confirm=true to proceed. There is nothing to cancel when no upgrade is in flight.
Inputs: confirm (required), cluster_id (required). Returns: object
skycloak_create_applicationAInspect
Create an application (OIDC or SAML client) in one realm, with its type, protocol, grant types and redirect URIs. A confidential client's secret is returned once here and is not retrievable later; skycloak_rotate_application_secret issues a new one. grant_types defaults to authorization_code, which requires redirect_uris; pass client_credentials for a machine-to-machine client.
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 one application (a Keycloak client role), with an optional description. Defining it grants it to nobody: skycloak_assign_application_role grants it to a service account. For a role that belongs to the realm rather than a client, use skycloak_create_realm_role.
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 in the workspace from a name, type, size, version and location, with an optional maintenance window. Asynchronous: the returned cluster starts in a provisioning state, so poll skycloak_get_cluster until its status is 'available'. Returns the new cluster_id. skycloak_list_cluster_locations, skycloak_list_cluster_types and skycloak_list_cluster_versions give the accepted values.
Inputs: name (required), size (required), version (required), location (required), +7 more. Returns: id, url, name, size, +7 more
skycloak_create_domainAInspect
Attach a custom domain to a cluster and return its new domain_id with the DNS records the customer must create. The domain serves nothing yet: the records have to exist, skycloak_verify_domain has to pass, and a realm has to be routed onto it with skycloak_create_domain_route.
Inputs: domain (required), cluster_id (required), subdomain. Returns: id, domain, is_active, subdomain, +4 more
skycloak_create_domain_routeAInspect
Route one realm of a cluster onto a custom domain, optionally allowing admin-console access and hiding the /realms/{name} path segment. Never use the master realm; it is reserved for cluster management and the API rejects it. Needs domain_id from skycloak_list_domains, and returns the new route_id.
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 whole-cluster database export (sql or pgdump) of one cluster and return the new export job. Asynchronous: poll skycloak_get_export until the status is 'completed' for the download URL. include_credentials requires an encryption_password, which encrypts the archive. For one realm's configuration instead of the whole database, use skycloak_create_realm_export.
Inputs: format (required), cluster_id (required), encryption_password, include_credentials. Returns: id, format, status, progress, +6 more
skycloak_create_identity_providerAInspect
Create an OIDC identity provider (SSO connection) in one realm, which adds its sign-in button to the realm's login page. provider_id comes from skycloak_list_identity_provider_templates and becomes the provider's alias, unique within the realm. Fill the endpoints with skycloak_discover_oidc, then check the connection with skycloak_test_identity_provider. OIDC only; SAML providers cannot be created here.
Inputs: realm (required), cluster_id (required), provider_id (required), display_name (required), +5 more. Returns: object
skycloak_create_openfga_instanceAInspect
Create an OpenFGA authorization 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 carrying its audience. It answers 403 when the plan does not include OpenFGA or the workspace hit its instance limit, 409 when the realm already has one, and 422 when the realm is 'master', missing or disabled.
Inputs: realm (required), cluster_id (required). Returns: id, realm, issuer, status, +6 more
skycloak_create_realmAInspect
Create a Keycloak realm on one cluster, enabled, with an optional display name, and return its summary including whether default branding was applied. The name must be unique within the cluster and no tool renames a realm afterwards. Users, clients and roles are separate calls.
Inputs: name (required), cluster_id (required), display_name. Returns: name, enabled, cluster_id, cluster_name, +5 more
skycloak_create_realm_exportAInspect
Export one Keycloak realm's configuration to an encrypted archive and return the new export job. Asynchronous: poll skycloak_get_realm_export until the status is 'completed'. The archive is always encrypted, so encryption_password is required and the same password is needed to import it again. This covers one realm; 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_groupAInspect
Create a group in one realm, nested under parent_id when given, and return its new group_id and path. The group starts empty; add users with skycloak_add_realm_user_to_group.
Inputs: name (required), realm (required), cluster_id (required), parent_id. Returns: id, name, path
skycloak_create_realm_importAInspect
Import a Keycloak realm into one cluster from either an uploaded archive (upload_s3_key) or an existing realm export (source_export_id), exactly one of the two, and return the new import job. Asynchronous: poll skycloak_get_realm_import. It creates a new realm and refuses a name collision with 409 rather than overwriting, and it brings users and their credentials with it, so set confirm=true to proceed. password decrypts an encrypted archive, and it is the password the archive was exported with.
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 for uploading a realm archive to one cluster, returning upload_url and s3_key. It uploads nothing and imports nothing by itself: PUT the archive to upload_url, then pass s3_key to skycloak_create_realm_import as upload_s3_key. Not needed when importing an existing export, which takes source_export_id instead.
Inputs: cluster_id (required). Returns: s3_key, upload_url
skycloak_create_realm_roleAInspect
Create a realm-scoped role in one realm, with an optional description. The role is defined but held by nobody until skycloak_assign_realm_user_role grants it to a user. For a role that belongs to one application, use skycloak_create_application_role.
Inputs: name (required), realm (required), cluster_id (required), description. Returns: name, composite, description
skycloak_create_realm_userAInspect
Create a user in one realm. temporary_password is the required initial password, at least 8 characters and also subject to the realm's Keycloak password policy. Despite the field name the API documents it as the initial password and does not mark the credential temporary, so do not promise the user a forced reset at first sign-in. The user is always created enabled, whatever the enabled argument says; use skycloak_update_realm_user to disable one. Returns the new user_id. Roles and group membership are separate calls.
Inputs: email (required), realm (required), username (required), cluster_id (required), +4 more. Returns: id, email, enabled, username, +3 more
skycloak_create_siem_destinationAInspect
Create a SIEM destination for the workspace, forwarding events over syslog, S3 or HTTP, and return its new destination_id. Credentials are write-only and cannot be read back afterwards. Check delivery with skycloak_test_siem_destination.
Inputs: name (required), type (required), source (required), s3, +3 more. Returns: id, s3, http, name, +14 more
skycloak_create_webhook_subscriptionAInspect
Create a webhook subscription that posts the chosen events to a URL, and return its new webhook_id. name, url, source, signing_secret and event_types are required, and the signing secret and any authorization header are write-only afterwards. Event type values come from skycloak_list_webhook_event_types; test delivery with skycloak_test_webhook_subscription.
Inputs: url (required), name (required), source (required), event_types (required), +5 more. Returns: id, url, name, source, +8 more
skycloak_delete_applicationADestructiveInspect
Delete one application (OIDC or SAML client) from a realm, together with the roles it defines and its secret, so anything signing in through that client_id breaks. This cannot be undone. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), client_id (required), cluster_id (required). Returns: object
skycloak_delete_application_roleADestructiveInspect
Delete one role defined on an application. Every user, group and service account holding it loses it, and the definition cannot be recovered. Set confirm=true to proceed. To revoke a single grant instead, use skycloak_remove_application_role.
Inputs: realm (required), confirm (required), client_id (required), role_name (required), +1 more. Returns: object
skycloak_delete_clusterADestructiveInspect
Permanently delete one Keycloak cluster with every realm, user, client and setting on it. This is irreversible and the data cannot be recovered. Set confirm=true to proceed. To keep a copy first, run skycloak_create_export and download the archive.
Inputs: id (required), confirm (required). Returns: object
skycloak_delete_cluster_maintenance_windowADestructiveInspect
Delete one cluster's own maintenance window, after which the cluster follows the workspace default. Set confirm=true to proceed. To change the window instead of removing it, use skycloak_set_cluster_maintenance_window.
Inputs: confirm (required), cluster_id (required). Returns: object
skycloak_delete_domainADestructiveInspect
Remove one custom domain from a cluster, so the hostname stops serving Keycloak along with every realm route on it. Set confirm=true to proceed. To drop a single realm from the domain instead, use skycloak_delete_domain_route.
Inputs: confirm (required), domain_id (required), cluster_id (required). Returns: object
skycloak_delete_domain_routeADestructiveInspect
Remove one realm route from a custom domain, so that hostname stops serving that realm. The domain itself stays. Set confirm=true to proceed, and use skycloak_delete_domain to remove the domain with all of its routes.
Inputs: confirm (required), route_id (required), domain_id (required), cluster_id (required). Returns: object
skycloak_delete_email_brandingADestructiveInspect
Reset one realm's email-template branding to the defaults, discarding the colors, logos and footer set through skycloak_upsert_email_branding. Set confirm=true to proceed. The realm's SMTP configuration is not affected.
Inputs: realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_exportADestructiveInspect
Delete one whole-cluster database export archive, after which its download URL stops working. Set confirm=true to proceed, and take export_id from skycloak_list_exports. It covers the exports skycloak_create_export makes, not realm exports.
Inputs: confirm (required), export_id (required), cluster_id (required). Returns: object
skycloak_delete_extensionADestructiveInspect
Delete a custom extension from the workspace catalog, so it can no longer be installed anywhere. Set confirm=true to proceed. This is the catalog entry; to remove an extension from one cluster use skycloak_uninstall_extension.
Inputs: confirm (required), extension_id (required). Returns: object
skycloak_delete_identity_providerADestructiveInspect
Delete one identity provider from a realm, so its sign-in button disappears and nobody can authenticate through it any more. Set confirm=true to proceed. To switch it off reversibly instead, call skycloak_update_identity_provider with enabled=false.
Inputs: realm (required), confirm (required), cluster_id (required), provider_id (required). Returns: object
skycloak_delete_login_brandingADestructiveInspect
Reset one realm's login-page branding to the defaults, discarding the colors, logo, links and toggles set through skycloak_upsert_login_branding. Set confirm=true to proceed. Custom theme assignments are not affected.
Inputs: realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_openfga_instanceADestructiveInspect
Permanently delete one OpenFGA instance with its deployment, route and database; the authorization data in it cannot be recovered. Removal is asynchronous, so the instance shows 'deleting' until it leaves skycloak_list_openfga_instances. Works even without OpenFGA access on the plan. Set confirm=true to proceed.
Inputs: confirm (required), cluster_id (required), instance_id (required). Returns: object
skycloak_delete_realmADestructiveInspect
Permanently delete one realm from a cluster, with every user, client, role, group and setting in it. This is irreversible. Set confirm=true to proceed. To keep a copy first, run skycloak_create_realm_export.
Inputs: name (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_realm_groupADestructiveInspect
Delete one realm group by group_id. Its members lose the membership and anything they inherited through it, and the group cannot be recovered. Set confirm=true to proceed. To remove one user instead, use skycloak_remove_realm_user_from_group.
Inputs: realm (required), confirm (required), group_id (required), cluster_id (required). Returns: object
skycloak_delete_realm_roleADestructiveInspect
Delete one realm role by name. Every user and group holding it loses it, and the role cannot be recovered. Set confirm=true to proceed. To revoke it from a single user instead, use skycloak_remove_realm_user_role.
Inputs: name (required), realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_realm_userADestructiveInspect
Delete one user from a realm, with their credentials and role and group memberships. This cannot be undone. Set confirm=true to proceed. To block sign-in reversibly instead, call skycloak_update_realm_user with enabled=false.
Inputs: realm (required), confirm (required), user_id (required), cluster_id (required). Returns: object
skycloak_delete_siem_destinationADestructiveInspect
Delete one SIEM destination, so events stop being forwarded to it and its configuration is gone. Set confirm=true to proceed. To pause it reversibly instead, update it with enabled=false.
Inputs: confirm (required), destination_id (required). Returns: object
skycloak_delete_smtpADestructiveInspect
Remove one realm's SMTP configuration, after which Keycloak cannot send email for that realm. Set confirm=true to proceed. To change the settings instead of removing them, use skycloak_upsert_smtp.
Inputs: realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_themeADestructiveInspect
Delete one custom theme from a cluster, discarding its archive for good. 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 gives a new ID.
Inputs: confirm (required), theme_id (required), cluster_id (required). Returns: object
skycloak_delete_webhook_subscriptionADestructiveInspect
Delete one webhook subscription, so its endpoint stops receiving events and the configuration is gone. Set confirm=true to proceed. To pause it reversibly instead, update it with enabled=false.
Inputs: confirm (required), webhook_id (required). Returns: object
skycloak_discover_oidcARead-onlyInspect
Fetch an external OIDC issuer's discovery document and return its authorization, token and userinfo endpoints with the scopes it supports. Reaches the issuer over the network and changes nothing in Skycloak. Use the result to fill skycloak_create_identity_provider.
Inputs: issuer_url (required). Returns: issuer, jwks_uri, token_endpoint, scopes_supported, +2 more
skycloak_download_theme_contentARead-onlyInspect
Download one custom theme's content archive from a cluster. It always returns the size and SHA-256, and attaches the ZIP itself only when it is under 1 MB. Needs theme_id from skycloak_list_themes. Read-only: skycloak_update_theme_content is what replaces an archive.
Inputs: theme_id (required), cluster_id (required). Returns: sha256, inlined, size_bytes
skycloak_export_cluster_eventsAInspect
Export one cluster's Keycloak events as a CSV document and return its contents inline. It sends no filters, so the API's default range applies, and it answers 422 when the result would exceed 10,000 events or 90 days. It stores nothing: for filtered, paged event rows use skycloak_query_events, and for a database dump use skycloak_create_export.
Inputs: cluster_id (required). Returns: document
skycloak_get_applicationARead-onlyInspect
Get one application (OIDC or SAML client) of a realm by its client ID, with name, type and protocol. Needs cluster_id from skycloak_list_clusters and client_id from skycloak_list_applications. Not for the client's roles; use skycloak_get_application_role for a role it defines and skycloak_list_application_roles for what its service account holds.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: Name, Type, Status, ClientID, +1 more
skycloak_get_application_roleARead-onlyInspect
Get one role defined on an application by name, with its description, composite flag and Keycloak identifiers. This reads the client's own role definition, not what its service account holds: use skycloak_list_application_roles for the grants. Needs client_id from skycloak_list_applications.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required). Returns: id, name, client_id, composite, +2 more
skycloak_get_client_theme_assignmentARead-onlyInspect
Get one application's login-theme override in a realm; an empty login means the client follows the realm's assignment. Covers this client and the login page only. For the realm-wide themes across login, account, admin and email, use skycloak_get_theme_assignment.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: login
skycloak_get_clusterARead-onlyInspect
Get one Keycloak cluster by its ID, with status, type, size, version, location, URL, timestamps and auto-upgrade flag. Use skycloak_list_clusters to find the ID. Poll this after skycloak_create_cluster or skycloak_update_cluster to watch the status settle.
Inputs: id (required). Returns: id, url, name, size, +7 more
skycloak_get_cluster_credentialsARead-onlyInspect
Get one cluster's Keycloak automation client credentials (client_id, client_secret and token URL) for an OAuth2 client_credentials flow against that cluster. Needs an API key carrying clusters:credentials:read, which signing in does not grant by default, so without it the call answers 403 and explains how to get a key that has it.
Inputs: cluster_id (required). Returns: client_id, token_url, client_secret
skycloak_get_cluster_insightsARead-onlyInspect
Get one aggregated analytics document for a cluster as raw JSON. type selects it: overview (the default), authentication, events, performance or security. These are rollups, not individual records; use skycloak_query_events for single events and skycloak_get_logs for log lines.
Inputs: cluster_id (required), type. Returns: json
skycloak_get_cluster_maintenance_windowARead-onlyInspect
Get the maintenance window set on one cluster: enabled, days of week, local start and end, and timezone. A 404 means the cluster has no window of its own and follows the workspace default. Disruptive changes the workspace defers are applied in this window.
Inputs: cluster_id (required). Returns: enabled, timezone, end_local, start_local, +1 more
skycloak_get_cluster_securityARead-onlyInspect
Get one cluster's edge-security configuration: IP allow-listing, rate limiting, WAF, geo-blocking and bot management, with the sections that are configured. CAPTCHA hostnames are listed separately by skycloak_list_cluster_captcha_domains, and the requests these rules acted on are in skycloak_get_security_logs.
Inputs: cluster_id (required). Returns: waf, geo_blocking, rate_limiting, bot_management, +1 more
skycloak_get_cluster_upgrade_pathARead-onlyInspect
Get the recommended version-upgrade steps for one cluster, in the order they should be applied from its current version. This is the plan; skycloak_list_cluster_upgrades is the history of upgrades already recorded. Apply a step with skycloak_update_cluster.
Inputs: cluster_id (required). Returns: steps
skycloak_get_domainARead-onlyInspect
Get one custom domain of a cluster by domain_id, with the DNS records to create and its verification and SSL status. Needs cluster_id and domain_id from skycloak_list_domains. For the realms served on it, use skycloak_list_domain_routes.
Inputs: domain_id (required), cluster_id (required). Returns: id, domain, is_active, subdomain, +4 more
skycloak_get_domain_routeARead-onlyInspect
Get one realm route on a custom domain by route_id, with the realm it serves and its admin-access setting. Needs cluster_id, domain_id and route_id from skycloak_list_domain_routes.
Inputs: route_id (required), domain_id (required), cluster_id (required). Returns: id, realm, hide_realm_path, allow_admin_access
skycloak_get_email_brandingARead-onlyInspect
Get one realm's email-template branding: status, primary color, header logo and footer company name. Covers Keycloak's outgoing emails only; the login page is skycloak_get_login_branding and the SMTP server is skycloak_get_smtp.
Inputs: realm (required), cluster_id (required). Returns: status, primary_color, footer_company_name, header_logo_light_url
skycloak_get_exportARead-onlyInspect
Get one whole-cluster database export job by export_id, with its status, progress, any error and, once completed, the time-limited download URL. Poll it after skycloak_create_export. For a single realm's archive, use skycloak_get_realm_export.
Inputs: export_id (required), cluster_id (required). Returns: id, format, status, progress, +6 more
skycloak_get_identity_providerARead-onlyInspect
Get one identity provider (SSO connection) of a realm by its alias, with display name, type and enabled state. provider_id is the alias exactly as skycloak_list_identity_providers reports it, and it is case-sensitive.
Inputs: realm (required), cluster_id (required), provider_id (required). Returns: Type, Enabled, ProviderID, DisplayName
skycloak_get_login_brandingARead-onlyInspect
Get one realm's login-page branding: status, colors, logo and the registration and forgot-password toggles. This is the no-code branding layer, separate from custom themes (skycloak_get_theme_assignment) and from email branding (skycloak_get_email_branding).
Inputs: realm (required), cluster_id (required). Returns: status, logo_url, primary_color, background_color, +2 more
skycloak_get_logsARead-onlyInspect
Read one cluster's recent Keycloak server process logs, each entry with timestamp, level, category and message, optionally narrowed by level and a free-text search (limit defaults to 50). Not edge or WAF traffic; use skycloak_get_security_logs for that. Not Keycloak user or admin events either; use skycloak_query_events for logins and admin operations.
Inputs: cluster_id (required), level, limit, search. Returns: logs, count
skycloak_get_openfga_instanceARead-onlyInspect
Get one OpenFGA instance of a cluster by instance_id, with its realm, status and the api_url, issuer and audience needed to call it. Needs instance_id from skycloak_list_openfga_instances. Poll it after skycloak_create_openfga_instance until the status is ready or failed.
Inputs: cluster_id (required), instance_id (required). Returns: id, realm, issuer, status, +6 more
skycloak_get_realmARead-onlyInspect
Get one Keycloak realm of a cluster by name, with its display name, enabled state and the security settings registration_allowed, login_with_email and ssl_required. Needs cluster_id from skycloak_list_clusters; skycloak_list_realms gives the realm names and answers the same question for many realms at once.
Inputs: realm (required), cluster_id (required). Returns: id, name, enabled, display_name, +6 more
skycloak_get_realm_exportARead-onlyInspect
Get one realm export job by export_id, with its realm, status, progress and any error. Poll it after skycloak_create_realm_export until the status is 'completed': the download URL appears only then and expires 24 hours later. For a whole-cluster database export, use skycloak_get_export.
Inputs: export_id (required). Returns: id, realm, scope, status, +9 more
skycloak_get_realm_groupARead-onlyInspect
Get one realm group by group_id, with its name and path. Needs group_id from skycloak_list_realm_groups. For the users in it, use skycloak_list_realm_group_members.
Inputs: realm (required), group_id (required), cluster_id (required). Returns: id, name, path
skycloak_get_realm_importARead-onlyInspect
Get one realm import job by import_id, with its realm, status, progress and any error. Poll it after skycloak_create_realm_import until the status is 'completed' or 'failed'.
Inputs: import_id (required). Returns: id, realm, status, progress, +7 more
skycloak_get_realm_roleARead-onlyInspect
Get one realm-scoped role by name, with its description. Not a role defined on an application; use skycloak_get_application_role for that. To see who holds it, use skycloak_list_user_roles per user.
Inputs: name (required), realm (required), cluster_id (required). Returns: name, composite, description
skycloak_get_realm_userARead-onlyInspect
Get one realm user by user_id, with username, email, enabled and email_verified. Needs user_id from skycloak_list_realm_users. It carries no roles or groups; use skycloak_list_user_roles and skycloak_list_user_groups for those.
Inputs: realm (required), user_id (required), cluster_id (required). Returns: id, email, enabled, username, +3 more
skycloak_get_security_logsARead-onlyInspect
Read one cluster's recent WAF and edge-security log entries: the action taken, attack type, source IP, HTTP method and message for requests the edge inspected or blocked (limit defaults to 50). Not Keycloak's own server logs; use skycloak_get_logs. Not login or admin events; use skycloak_query_events. For the rules producing these entries, see skycloak_get_cluster_security.
Inputs: cluster_id (required), limit, search. Returns: logs, count
skycloak_get_siem_destinationARead-onlyInspect
Get one SIEM destination by destination_id, with its type, transport settings, enabled state and health. Credentials stay write-only and are not returned. destination_id comes from skycloak_list_siem_destinations.
Inputs: destination_id (required). Returns: id, s3, http, name, +14 more
skycloak_get_smtpARead-onlyInspect
Get one realm's SMTP configuration: host, port, from address, auth type and status. Passwords are never returned. Needs cluster_id from skycloak_list_clusters and a realm name. Use skycloak_test_smtp to check that it actually delivers.
Inputs: realm (required), cluster_id (required). Returns: host, port, status, auth_type, +4 more
skycloak_get_themeARead-onlyInspect
Get one custom theme of a cluster by theme_id, with its name, status, theme types and restart_required. 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; skycloak_restart_cluster_instances applies it. Needs theme_id from skycloak_list_themes. This reads metadata, not the files, which skycloak_download_theme_content returns.
Inputs: theme_id (required), cluster_id (required). Returns: id, name, status, version, +3 more
skycloak_get_theme_assignmentARead-onlyInspect
Get the custom theme active for each Keycloak theme type (login, account, admin, email) in one realm; an empty value means Keycloak's built-in default. Realm-wide. For a single application's login override, use skycloak_get_client_theme_assignment, and for the workspace naming policy use skycloak_get_theme_settings.
Inputs: realm (required), cluster_id (required). Returns: admin, email, login, account
skycloak_get_theme_settingsARead-onlyInspect
Get the workspace's theme naming policy, which is whether exact_theme_names is on. On, every theme is served from a folder named exactly like the theme and that name survives content replaces; off, the default, the served folder changes on each replace unless the theme came from a platform migration. Workspace-wide and takes no arguments. It says nothing about which theme a realm uses (skycloak_get_theme_assignment) or a theme's files (skycloak_download_theme_content).
Returns: exact_theme_names
skycloak_get_webhook_subscriptionARead-onlyInspect
Get one webhook subscription by webhook_id, with its URL, source, event types and enabled state. The signing secret and authorization header stay write-only. webhook_id comes from skycloak_list_webhook_subscriptions.
Inputs: webhook_id (required). Returns: id, url, name, source, +8 more
skycloak_install_extensionAInspect
Install one catalog extension on a cluster, passing any required parameters keyed by parameter name. Asynchronous: poll skycloak_list_cluster_extensions until the status settles. extension_id comes from skycloak_list_extensions.
Inputs: cluster_id (required), extension_id (required), parameters. Returns: source, status, extension_id, extension_name, +3 more
skycloak_list_application_rolesARead-onlyInspect
List the realm and client roles granted to one application's service account, each with its name, client_role flag and description. These are grants held by the client itself, not the roles the client defines: use skycloak_get_application_role for a role it defines, skycloak_list_realm_roles for the realm's definitions, and skycloak_list_user_roles for a human user's roles. Needs client_id from skycloak_list_applications.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: count, roles
skycloak_list_applicationsARead-onlyInspect
List the applications (OIDC and SAML clients) of one realm, each with its client_id, name, type, protocol and status. Needs cluster_id from skycloak_list_clusters and a realm name from skycloak_list_realms, and it is where the client_id other application tools take comes from.
Inputs: realm (required), cluster_id (required). Returns: count, applications
skycloak_list_application_sessionsARead-onlyInspect
List the active user sessions on one application, each with its session ID, username, IP address and last access time. Read-only: it reports sessions and cannot end them. Needs client_id from skycloak_list_applications.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: count, sessions
skycloak_list_cluster_captcha_domainsARead-onlyInspect
List the hostnames registered for CAPTCHA protection on one cluster, with the maximum the workspace allows. Needs cluster_id from skycloak_list_clusters. The rest of the edge-security configuration is skycloak_get_cluster_security.
Inputs: cluster_id (required). Returns: count, domains, max_allowed
skycloak_list_cluster_extensionsARead-onlyInspect
List the extensions installed on one cluster, each with its installed version, the version available for that cluster's Keycloak, its status and upgrade_available. This is the installed set, while skycloak_list_extensions is the catalog to install from. Poll it after installing, upgrading or uninstalling, since those are asynchronous.
Inputs: cluster_id (required). Returns: count, extensions
skycloak_list_cluster_featuresARead-onlyInspect
List the Keycloak feature flags available to tenant clusters, with each flag's name and display name. Workspace-wide and takes no arguments; it does not say which flags one cluster has on.
Returns: features
skycloak_list_cluster_locationsARead-onlyInspect
List the deployment regions, each with the name and an available flag for this workspace. Workspace-wide and takes no arguments. Call it before skycloak_create_cluster: creating a cluster in a location the workspace cannot use is rejected.
Returns: locations
skycloak_list_clustersARead-onlyInspect
List the Keycloak clusters in the Skycloak workspace, each with its cluster_id, name, status, type, size, version, location and auto-upgrade flag. Start here: the cluster_id nearly every other tool needs comes from this list. Omit limit and offset to list the whole workspace; either one returns a single page and the result says so.
Inputs: limit, offset. Returns: count, clusters
skycloak_list_cluster_typesARead-onlyInspect
List the cluster types the workspace can provision, each with an available flag. Workspace-wide and takes no arguments. For the versions offered within a type, use skycloak_list_cluster_versions.
Returns: types
skycloak_list_cluster_upgradesARead-onlyInspect
List the version upgrades recorded for one cluster, each with its from_version, to_version and phase. This is history, including anything in flight; for the recommended next versions use skycloak_get_cluster_upgrade_path. Needs cluster_id from skycloak_list_clusters.
Inputs: cluster_id (required). Returns: upgrades
skycloak_list_cluster_versionsARead-onlyInspect
List the Keycloak versions on offer for one cluster type, flagging versions no longer offered, major version changes and breaking-change counts. Takes a type (keycloak or tidecloak), not a cluster_id. Not the plan for an existing cluster; use skycloak_get_cluster_upgrade_path for that.
Inputs: type (required). Returns: versions
skycloak_list_domain_routesARead-onlyInspect
List the realm routes configured on one custom domain, each with its route_id, realm, admin-access and hide_realm_path flags. A route maps one realm onto the hostname. Not for the domains themselves; use skycloak_list_domains, which is also where domain_id comes from.
Inputs: domain_id (required), cluster_id (required). Returns: routes
skycloak_list_domainsARead-onlyInspect
List the custom domains attached to one cluster, each with its domain_id, hostname, verification status, SSL status and active flag. Needs cluster_id from skycloak_list_clusters, and it is where domain_id comes from. Not the realm routes on a domain; use skycloak_list_domain_routes for those.
Inputs: cluster_id (required). Returns: count, domains
skycloak_list_exportsARead-onlyInspect
List the whole-cluster database export jobs of one cluster, each with its export_id, format, status and expiry. Needs cluster_id from skycloak_list_clusters. Realm exports are a separate surface with no list; read one with skycloak_get_realm_export.
Inputs: cluster_id (required). Returns: count, exports
skycloak_list_extensionsARead-onlyInspect
List the workspace's extension catalog: the extensions available to install, with each one's extension_id, version, source and supported Keycloak versions. Workspace-wide and takes no arguments. Not what a cluster is running; use skycloak_list_cluster_extensions for that.
Returns: count, extensions
skycloak_list_identity_providersARead-onlyInspect
List the identity providers (SSO connections) of a realm, each with its alias (provider_id), type, display name, enabled state, realm and cluster. Omit realm to cover every realm and cluster_id to cover every cluster, so one call answers an SSO question across the whole fleet; clusters that could not be read come back under unreachable. These are configured providers, not the catalog to create from, which is skycloak_list_identity_provider_templates.
Inputs: realm, cluster_id. Returns: count, unreachable, identity_providers
skycloak_list_identity_provider_templatesARead-onlyInspect
List the pre-configured identity-provider templates of the workspace, with each one's id, name and type. Workspace-wide and takes no arguments. Pass a template id as provider_id to skycloak_create_identity_provider; for the providers a realm already has, use skycloak_list_identity_providers.
Returns: templates
skycloak_list_openfga_instancesARead-onlyInspect
List the OpenFGA instances bound to one cluster's realms, each with its instance_id, realm and status (provisioning, ready, failed or deleting). Works on every plan, so a workspace that lost OpenFGA access still sees what it has. For the URLs to call an instance with, use skycloak_get_openfga_instance.
Inputs: cluster_id (required). Returns: count, instances
skycloak_list_realm_group_membersARead-onlyInspect
List the users belonging to one realm group, each with username, user_id and email. Needs group_id from skycloak_list_realm_groups. For one user's groups, use skycloak_list_user_groups.
Inputs: realm (required), group_id (required), cluster_id (required). Returns: count, users
skycloak_list_realm_groupsARead-onlyInspect
List the top-level groups of one realm, each with its group_id, name and path; child groups are not expanded. This is where group_id comes from. For a group's users use skycloak_list_realm_group_members, and for one user's groups use skycloak_list_user_groups.
Inputs: realm (required), cluster_id (required). Returns: count, groups
skycloak_list_realm_rolesARead-onlyInspect
List every realm-scoped role defined in one realm, with each role's name and description. These are definitions, not assignments: use skycloak_list_user_roles for the roles one user holds and skycloak_list_application_roles for what a service account holds. Roles defined on a client are separate; see skycloak_get_application_role.
Inputs: realm (required), cluster_id (required). Returns: count, roles
skycloak_list_realmsARead-onlyInspect
List Keycloak realms with their enabled state, registration_allowed, login_with_email, ssl_required and the cluster each belongs to. Omit cluster_id to cover every cluster in the workspace; clusters that could not be read come back under unreachable, so a partial answer is visible rather than silent. Use it to get the realm names other tools take; skycloak_get_realm reads one realm.
Inputs: cluster_id. Returns: count, realms, unreachable
skycloak_list_realm_usersARead-onlyInspect
List the users of one realm, each with username, user_id, email and enabled state. Needs cluster_id from skycloak_list_clusters and a realm from skycloak_list_realms, and it is where the user_id the user tools take comes from.
Inputs: realm (required), cluster_id (required). Returns: count, users
skycloak_list_siem_destinationsARead-onlyInspect
List the workspace's SIEM destinations, each with its destination_id, name, type, enabled state and health status. Workspace-wide and takes no arguments; credentials are never returned.
Returns: count, destinations
skycloak_list_themesARead-onlyInspect
List the custom themes uploaded to one cluster, each with its theme_id, name, status, theme types and restart_required. This is where theme_id comes from. restart_required is true on a theme whose replaced content is not live yet; see skycloak_get_theme_settings and skycloak_restart_cluster_instances. It does not say which theme a realm uses; that is skycloak_get_theme_assignment.
Inputs: cluster_id (required). Returns: count, themes
skycloak_list_user_groupsARead-onlyInspect
List the groups one user belongs to, each with its name and path. Needs user_id from skycloak_list_realm_users. For the other direction, the users in a group, use skycloak_list_realm_group_members.
Inputs: realm (required), user_id (required), cluster_id (required). Returns: count, groups
skycloak_list_user_rolesARead-onlyInspect
List the realm roles one user currently holds, by user_id from skycloak_list_realm_users. These are that user's grants, not the realm's catalogue of roles (skycloak_list_realm_roles) and not an application service account's roles (skycloak_list_application_roles).
Inputs: realm (required), user_id (required), cluster_id (required). Returns: count, roles
skycloak_list_webhook_event_typesARead-onlyInspect
List the webhook event types that can be subscribed to, each with its category and deprecated flag, optionally filtered by source (platform or keycloak). These are the values event_types takes on skycloak_create_webhook_subscription. Not the subscriptions themselves; use skycloak_list_webhook_subscriptions.
Inputs: source. Returns: count, event_types
skycloak_list_webhook_subscriptionsARead-onlyInspect
List the workspace's webhook subscriptions, each with its webhook_id, name, source, enabled state and event-type count; filter by source, cluster_id and enabled. Signing secrets are never returned. For the catalogue of event types, use skycloak_list_webhook_event_types.
Inputs: source, enabled, cluster_id. Returns: count, subscriptions
skycloak_query_eventsARead-onlyInspect
Query one cluster's Keycloak user and admin events (logins, token grants, admin operations) and return the matching rows. Filter user events with types and error, admin events with operation_types, and either kind with realm, username, start_time/end_time and order; without start_time the API covers only the last 24 hours. 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 the same events as a CSV document use skycloak_export_cluster_events, and for Keycloak's process logs use skycloak_get_logs.
Inputs: cluster_id (required), error, limit, order, +9 more. Returns: count, events
skycloak_remove_application_roleADestructiveIdempotentInspect
Revoke a role from one application's service account, which loses that access on its next token. Pass the same role_client_id that granted a client role. The role itself is not deleted; skycloak_delete_application_role does that, and skycloak_remove_realm_user_role is the equivalent for a user.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +1 more. Returns: object
skycloak_remove_cluster_captcha_domainADestructiveInspect
Remove one hostname from CAPTCHA protection on a cluster, so requests to it stop being challenged. Set confirm=true to proceed. It does not remove a custom domain, which is skycloak_delete_domain.
Inputs: confirm (required), hostname (required), cluster_id (required). Returns: object
skycloak_remove_realm_user_from_groupADestructiveIdempotentInspect
Remove one realm user from one realm group, so the user loses what the group carried. Both the user and the group remain. To delete the group itself use skycloak_delete_realm_group.
Inputs: realm (required), user_id (required), group_id (required), cluster_id (required). Returns: object
skycloak_remove_realm_user_roleADestructiveIdempotentInspect
Revoke a realm role from a realm user, who loses whatever that role granted. The role itself stays defined in the realm. For an application's service account use skycloak_remove_application_role; to delete the role everywhere use skycloak_delete_realm_role.
Inputs: realm (required), user_id (required), role_name (required), cluster_id (required). Returns: object
skycloak_restart_cluster_instancesADestructiveInspect
Restart one cluster's Keycloak instances, disrupting live traffic on that cluster. Mainly needed after skycloak_update_theme_settings turns exact_theme_names on: a theme replaced under its exact name serves its new content only once Keycloak restarts, which is what restart_required on skycloak_get_theme and skycloak_list_themes reports. Applies immediately unless the workspace defers disruptive changes to the maintenance window, reported as deferred=true with next_window (RFC3339) when known. Conflicts when the cluster is already busy with a restart or update, is not in an available state, or its 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_secretADestructiveInspect
Generate a new client secret for one confidential application and return it. The previous secret stops working at once, so every integration using it fails until updated, and the new value is not retrievable later. Needs client_id from skycloak_list_applications.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: client_secret
skycloak_set_client_theme_assignmentAIdempotentInspect
Set or clear one application's login-theme override in a realm. Pass a theme ID from skycloak_list_themes, or an empty string to fall back to the realm's assignment. Affects this client's login page only; skycloak_set_theme_assignment sets the realm-wide themes.
Inputs: realm (required), client_id (required), cluster_id (required), login. Returns: login
skycloak_set_cluster_maintenance_windowAIdempotentInspect
Create or replace one cluster's maintenance window: days of week, local start and end, timezone and enabled. It replaces the whole window, so send every field. Disruptive changes the workspace defers are applied in this window; skycloak_delete_cluster_maintenance_window returns the cluster to the workspace default.
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_assignmentAIdempotentInspect
Activate custom themes for one realm, one per Keycloak theme type: login, account, admin and email. Pass a theme ID from skycloak_list_themes to activate it, or an empty string to reset that type to Keycloak's built-in default; types you omit keep their current theme. The change is live for everyone in the realm. For a single application's login page, use skycloak_set_client_theme_assignment.
Inputs: realm (required), cluster_id (required), admin, email, +2 more. Returns: admin, email, login, account
skycloak_test_identity_providerAInspect
Check connectivity from one realm to one of its identity providers and report success with the message. client_id and client_secret, when given, are used for this test only and are not saved; skycloak_update_identity_provider is what changes the stored provider.
Inputs: realm (required), cluster_id (required), provider_id (required), client_id, +1 more. Returns: message, success
skycloak_test_siem_destinationAInspect
Send a test event to one SIEM destination and report success with the message. It delivers a real event to the external system and changes no Skycloak configuration.
Inputs: destination_id (required). Returns: message, success
skycloak_test_smtpAInspect
Send a test email through one realm's configured SMTP server to the address given, and report success with the server's message. It really sends mail, but changes no configuration; skycloak_upsert_smtp is what edits the settings.
Inputs: email (required), realm (required), cluster_id (required). Returns: message, success
skycloak_test_webhook_subscriptionAInspect
Send a test event to one webhook subscription and report success with the delivery ID. It makes a real HTTP request to the subscriber's URL and changes no configuration.
Inputs: webhook_id (required), event_type. Returns: success, delivery_id, duration_ms, attempted_at, +3 more
skycloak_uninstall_extensionADestructiveInspect
Remove one installed extension from a cluster, so that cluster stops loading it. Set confirm=true to proceed. The extension stays in the workspace catalog and can be installed again; skycloak_delete_extension is what removes it from the catalog.
Inputs: confirm (required), cluster_id (required), extension_id (required). Returns: object
skycloak_update_applicationAIdempotentInspect
Update one application's display name, description or redirect URIs. redirect_uris replaces the whole list rather than adding to it, so a URI left out stops working for sign-in. Not for secrets (skycloak_rotate_application_secret) or roles (skycloak_update_application_role).
Inputs: realm (required), client_id (required), cluster_id (required), name, +2 more. Returns: Name, Type, Status, ClientID, +1 more
skycloak_update_application_roleAIdempotentInspect
Rename one role defined on an application or change its description; pass at least one of new_name and description, and the field you omit keeps its value. Existing grants survive the rename, but anything referring to the old name has to be updated. Not for granting or revoking; use skycloak_assign_application_role and skycloak_remove_application_role.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +2 more. Returns: id, name, client_id, composite, +2 more
skycloak_update_clusterAIdempotentInspect
Change one cluster's Keycloak version, instance size or auto-upgrade flag. A new version starts an upgrade of the running cluster and a new size resizes it, both applied to live infrastructure; poll skycloak_get_cluster for the status and skycloak_cancel_cluster_upgrade stops an upgrade in flight. skycloak_get_cluster_upgrade_path gives the supported version steps.
Inputs: cluster_id (required), size, version, auto_upgrade_enabled. Returns: ID, URL, Name, Size, +7 more
skycloak_update_cluster_securityAIdempotentInspect
Update one cluster's edge-security configuration: IP allow-listing, rate limiting, WAF, geo-blocking and bot management. Only the sections you send are changed and CAPTCHA settings are left as they are. The rules apply at the edge straight away, so a wrong allow-list or geo rule can lock legitimate users out of the cluster.
Inputs: cluster_id (required), waf, geo_blocking, rate_limiting, +2 more. Returns: waf, geo_blocking, rate_limiting, bot_management, +1 more
skycloak_update_domain_routeADestructiveIdempotentInspect
Update one domain route's admin-console access and CORS allowed origins. Fields you omit keep their current value, cors_allowed_origins replaces the whole list, and allow_admin_access=false makes the admin console unreachable through this domain. The realm a route serves cannot be changed: delete it with skycloak_delete_domain_route and create a new one.
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_extensionAIdempotentInspect
Rename a custom extension in the workspace catalog or change its description. Catalog metadata only: no cluster is touched, and the installed version is changed by skycloak_upgrade_extension.
Inputs: extension_id (required), name, description. Returns: id, name, source, version, +3 more
skycloak_update_identity_providerAIdempotentInspect
Update one identity provider's display name and enabled state. Disabling it removes that sign-in button from the realm's login page without deleting the connection. Upstream client credentials and endpoints cannot be changed here; delete and recreate the provider for those.
Inputs: realm (required), cluster_id (required), provider_id (required), enabled, +1 more. Returns: Type, Enabled, ProviderID, DisplayName
skycloak_update_realmADestructiveIdempotentInspect
Update one realm's display name and enabled state. Fields you omit keep their current value, and enabled=false stops every sign-in to the realm. Only these two fields are editable here; a realm cannot be renamed, and skycloak_create_realm and skycloak_delete_realm handle the rest.
Inputs: realm (required), cluster_id (required), enabled, display_name. Returns: id, name, enabled, display_name, +6 more
skycloak_update_realm_groupAIdempotentInspect
Rename one realm group, keeping its group_id and its members, and return the group with its updated path. Needs group_id from skycloak_list_realm_groups. Membership changes go through skycloak_add_realm_user_to_group and skycloak_remove_realm_user_from_group.
Inputs: name (required), realm (required), group_id (required), cluster_id (required). Returns: id, name, path
skycloak_update_realm_roleAIdempotentInspect
Rename one realm-scoped role or change its description, leaving every assignment of it in place. Omitted fields keep their value, and anything referring to the old name has to be updated. Not for a role defined on an application; use skycloak_update_application_role.
Inputs: name (required), realm (required), cluster_id (required), new_name, +1 more. Returns: name, composite, description
skycloak_update_realm_userADestructiveIdempotentInspect
Update one realm user's email, first and last name, enabled and email_verified. Fields you omit keep their current value, and enabled=false blocks the user from signing in. It changes no password, role or group membership.
Inputs: realm (required), user_id (required), cluster_id (required), email, +4 more. Returns: id, email, enabled, username, +3 more
skycloak_update_siem_destinationAIdempotentInspect
Update one SIEM destination by destination_id: only the fields you send change, and credentials stay write-only. To stop forwarding without losing the configuration, set enabled=false rather than deleting it.
Inputs: destination_id (required), s3, http, name, +4 more. Returns: id, s3, http, name, +14 more
skycloak_update_themeAIdempotentInspect
Update one theme's name, description or version label. Metadata only: the theme's files are untouched, and skycloak_update_theme_content is what replaces the archive. Realm and client assignments are unaffected.
Inputs: theme_id (required), cluster_id (required), name, version, +1 more. Returns: id, name, status, version, +3 more
skycloak_update_theme_contentADestructiveIdempotentInspect
Replace one theme's archive in place, keeping the theme's ID, name and every realm and application assignment, so a theme can be edited without deleting and re-uploading it. Pass the ZIP or Keycloakify JAR base64-encoded in content_base64, up to 50 MB. Set confirm=true to proceed: the archive it overwrites cannot be recovered. The replacement must still provide every theme type the theme has today, and a theme created by a platform migration is pinned and answers 409. With exact_theme_names on (see skycloak_get_theme_settings) the theme reports restart_required=true until skycloak_restart_cluster_instances applies it. Name, description and version alone go through skycloak_update_theme.
Inputs: confirm (required), theme_id (required), cluster_id (required), content_base64 (required), +2 more. Returns: id, name, status, version, +3 more
skycloak_update_theme_settingsADestructiveIdempotentInspect
Turn the workspace-wide exact_theme_names policy on or off, choosing whether a theme is served from a folder named exactly like the theme or from a folder that changes on each content replace. The API key must belong to a workspace owner or admin; any other role gets 403 even with themes:write. Turning it on moves existing themes to their exact folders in the background, and a theme that cannot move right away completes the move on its next content replace; turning it off takes effect on each theme's next replace. Under this policy a theme whose content is replaced under its exact name reports restart_required=true from skycloak_get_theme and skycloak_list_themes until skycloak_restart_cluster_instances runs. Set confirm=true to proceed. Naming policy only, not a theme's files (skycloak_update_theme_content) or its assignment (skycloak_set_theme_assignment).
Inputs: confirm (required), exact_theme_names (required). Returns: exact_theme_names
skycloak_update_webhook_subscriptionAIdempotentInspect
Update one webhook subscription by webhook_id: URL, event types, enabled state, scope or secrets. Only the fields you send change; use clear_authorization_header, clear_cluster_id or clear_realm_id to null a nullable field, since an omitted field keeps its value.
Inputs: webhook_id (required), url, name, source, +9 more. Returns: id, url, name, source, +8 more
skycloak_upgrade_extensionAIdempotentInspect
Upgrade an extension already installed on a cluster to the version available for that cluster's Keycloak, replacing the running artifact. Asynchronous: poll skycloak_list_cluster_extensions. Not for catalog metadata, which skycloak_update_extension edits without touching any cluster.
Inputs: cluster_id (required), extension_id (required). Returns: source, status, extension_id, extension_name, +3 more
skycloak_upsert_email_brandingAIdempotentInspect
Create or update one realm's email-template branding: primary color, light and dark header logos, company URL, footer company name and footer text. Fields you omit keep their current value, and an empty string cannot clear one. Covers Keycloak's emails only; the login page is skycloak_upsert_login_branding and the mail server is skycloak_upsert_smtp.
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_brandingAIdempotentInspect
Create or update one realm's login-page branding: colors, logo, favicon, font, terms and privacy links, and the registration, remember-me, forgot-password and Powered by Skycloak toggles. Fields you omit keep their current value, and an empty string cannot clear one. This is the no-code layer over Keycloak's login page; a full custom theme goes through skycloak_set_theme_assignment, and skycloak_delete_login_branding resets everything here.
Inputs: realm (required), cluster_id (required), font_url, logo_url, +9 more. Returns: status, logo_url, primary_color, background_color, +2 more
skycloak_upsert_smtpAIdempotentInspect
Create or replace one realm's SMTP configuration with basic auth, so Keycloak can send email for that realm. Omitting password keeps the stored one; the other fields are replaced with what you send. Check delivery with skycloak_test_smtp, and skycloak_delete_smtp removes the configuration.
Inputs: host (required), port (required), realm (required), cluster_id (required), +5 more. Returns: host, port, status, auth_type, +4 more
skycloak_verify_domainAIdempotentInspect
Run a DNS check against one custom domain and return its updated verification and SSL status. Safe to repeat: when the records are not in place it only reports that the domain is still unverified. Needs domain_id from skycloak_list_domains; skycloak_get_domain reads the status without rechecking.
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
Scored across 141 tools
Despite 141 tools, nearly every one names a distinct resource+operation, and descriptions actively disambiguate neighbours (e.g. list_realm_roles vs list_user_roles vs list_application_roles, get_logs vs get_security_logs vs query_events, update_theme vs update_theme_content vs update_theme_settings). The dense theme/branding cluster and the three role surfaces still require careful reading, so it is not a clean 5, but misselection should be rare.
All tools use a uniform skycloak_ prefix plus snake_case verb_noun (list_, get_, create_, update_, delete_, test_, set_, remove_), consistently suffixed by the resource. Minor verb variance exists for grant/revoke semantics (add_ vs assign_ vs create_, remove_ vs delete_) and for upsert_ vs create_/update_ on branding and SMTP, but the pattern stays readable throughout.
141 tools is far beyond what an agent can navigate reliably in one surface, even though the domain (clusters, realms, users, roles, groups, SSO, themes, branding, SMTP, webhooks, SIEM, extensions, OpenFGA, exports, logging) genuinely justifies substantial breadth. The set would benefit from consolidation (e.g. theme settings/assignment split across six tools, near-duplicate get_ variants) rather than one tool per endpoint.
Coverage is unusually thorough: most resources have full list/get/create/update/delete plus async polling counterparts, and cross-references close loops between related tools. Gaps remain around session control (list_application_sessions cannot revoke), realm export listing, user password management, and client scopes/keys, but these are workaround-able rather than blocking.
Maintenance
Related MCP Connectors
An MCP server that provides an API to LLMs to manage their JumpCloud resources.
Official Microsoft MCP Server to query Microsoft Entra data using natural language
An MCP server that let you interact with Cycloid.io Internal Development Portal and Platform
Governed MCP gateway: one endpoint for your tools, with credential custody and audit log.
Related MCP Servers
AlicenseBqualityDmaintenanceMCP server for interacting with Keyshade's secrets management platform, enabling secure retrieval and management of secrets via natural language.449Mozilla Public 2.0- AlicenseNot gradedqualityBmaintenanceMCP server for Authentik identity management, enabling natural language management of users, groups, applications, flows, policies, providers, and more.468 npm17MIT
- AlicenseNot gradedqualityDmaintenanceA Model Context Protocol (MCP) server that provides a natural language interface for managing Keycloak identity and access management through its REST API.MIT
- AlicenseNot gradedqualityBmaintenanceMCP server for managing Ory Kratos identities, sessions, and authentication flows, enabling AI assistants to perform identity management tasks via natural language.13 npm1MIT