Skip to main content
Glama

skycloak-mcp

Smithery

Skycloak (관리형 Keycloak)를 위한 공식 Model Context Protocol 서버입니다. 클러스터, 영역(realm), 애플리케이션 및 SSO를 모든 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 로그인이 있는 스테이징 영역을 만드세요."

  • "지난 주에 프로덕션 영역에 누가 추가되었나요?"

  • "관리자 이벤트를 Datadog 웹훅으로 전달하는 SIEM 대상을 설정하세요."

Related MCP server: MCP Authentik

인증 및 보안

  • Hosted HTTP, OAuth 사용 (구성할 자격 증명 없음). 클라이언트를 헤더 없이 https://mcp.skycloak.io로 지정하세요. 서버는 401 응답과 함께 /.well-known/oauth-protected-resource에 있는 RFC 9728 메타데이터에 대한 포인터를 반환합니다. 클라이언트는 Skycloak 로그인 영역에 대해 브라우저 인가 코드 흐름을 실행하고, 그 결과로 받은 액세스 토큰은 세션이 실행되는 짧은 수명의 워크스페이스 범위 API 키로 교환됩니다. 키는 한 시간 동안 지속되며 자동으로 갱신됩니다. 클라이언트 구성에 저장되는 것은 없습니다.

  • Hosted 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은 저장된 키를 제거합니다.

  • Headless / 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입니다.

영역

읽기 전용

쓰기 (--allow-writes)

클러스터

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

엣지 보안

get_cluster_security, list_cluster_captcha_domains

update_cluster_security, add_cluster_captcha_domain, remove_cluster_captcha_domain

Realm

list_realms, get_realm

create_realm, update_realm, delete_realm

애플리케이션

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

ID 공급자

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

사용자, 역할 및 그룹

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

사용자 지정 도메인

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

브랜딩 및 테마

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

확장 프로그램

list_extensions, list_cluster_extensions

install_extension, upgrade_extension, update_extension, uninstall_extension, delete_extension

SMTP

get_smtp

upsert_smtp, delete_smtp, test_smtp

내보내기 및 로그

list_exports, get_export, get_logs, get_security_logs, query_events

create_export, delete_export, export_cluster_events

Realm 가져오기 및 내보내기

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

웹훅

list_webhook_event_types, list_webhook_subscriptions, get_webhook_subscription

create_webhook_subscription, update_webhook_subscription, delete_webhook_subscription, test_webhook_subscription

규칙: 파괴적 도구(delete_*, uninstall_extension, cancel_cluster_upgrade)는 confirm=true가 필요합니다. create_cluster는 비동기적입니다. 클러스터가 available 상태가 될 때까지 get_cluster를 폴링하세요. create_domain은 고객이 생성해야 하는 DNS 레코드를 반환하며, verify_domain은 DNS 검사를 트리거합니다. set_theme_assignment는 Keycloak 테마 유형별로 사용자 지정 테마를 활성화합니다(빈 문자열은 기본 제공 기본값으로 재설정). update_cluster_security는 CAPTCHA 설정을 변경하지 않습니다. Realm 가져오기/내보내기는 하나의 realm 구성을 이동하며, 전체 클러스터 데이터베이스를 덤프하는 create_export와는 별개입니다. 둘 다 비동기적이며, realm 아카이브는 항상 암호화되므로 다시 가져오려면 내보내기 시 사용한 비밀번호가 필요합니다. Realm은 기존 내보내기(source_export_id)에서 직접 가져오거나 업로드된 아카이브(create_realm_import_upload_url, PUT, 그다음 upload_s3_key)에서 가져올 수 있습니다. 가져오기는 realm을 생성하며, 덮어쓰지 않고 이름 충돌을 거부합니다. 또한 사용자와 자격 증명을 함께 가져오므로 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 keychain

Claude 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은 새 연결을 중지하고 진행 중인 호출을 드레인합니다.

OAuth 경로는 SKYCLOAK_ISSUER와 SKYCLOAK_DASHBOARD_URL이 설정될 때마다 활성화되며, 기본적으로 설정되어 있습니다. 그러면 GET /.well-known/oauth-protected-resource가 인증 없이 제공되며, 영역을 인증 서버로 명명합니다. resource 값은 SKYCLOAK_PUBLIC_URL이 설정된 경우 해당 값에서 가져오고, 그렇지 않으면 요청 자체의 Host와 스키마에서 가져오므로 인그레스 뒤의 단일 호스트 배포에는 추가 구성이 필요하지 않습니다. 스키마는 X-Forwarded-Proto가 있는 경우 해당 값에서 가져오고, 그렇지 않으면 루프백 호스트를 제외한 모든 항목에 대해 기본적으로 https로 설정됩니다. TLS가 업스트림에서 종료되고 http:// 식별자를 게시하면 클라이언트가 연결한 URL과 일치하지 않기 때문입니다. 인그레스가 Host를 재작성하는 경우 SKYCLOAK_PUBLIC_URL을 설정하세요. 문서에는 openid profile email이 scopes_supported로 나열되어 있으며, WWW-Authenticate 챌린지는 이를 scope 매개변수로 반복하므로 둘 중 하나를 읽는 클라이언트는 영역에 이를 요청합니다. openid는 필수입니다. 토큰 교환 시 대시보드가 Keycloak의 userinfo 엔드포인트를 호출하고 Keycloak이 openid 없이 부여된 토큰을 거부하기 때문입니다. openid 없이 도착한 토큰은 성공할 수 없는 교환으로 전달되지 않고 검증 시 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 키는 절대 기록되지 않습니다.

구성

환경 변수

기본값

SKYCLOAK_API_KEY

없음 (stdio의 경우 선택 사항; HTTP 클라이언트는 대신 API-Key 헤더 제공)

SKYCLOAK_ENDPOINT

https://api.skycloak.io

SKYCLOAK_API_VERSION

현재 API 버전

SKYCLOAK_ISSUER

https://login.app.skycloak.io/realms/skycloak (CLI 로그인 및 HTTP 전송이 토큰을 검증하는 인증 서버)

SKYCLOAK_CLIENT_ID

skycloak-mcp (CLI 디바이스 플로우 전용)

SKYCLOAK_DASHBOARD_URL

https://app.skycloak.io (CLI 키 및 HTTP 세션 키 발행)

SKYCLOAK_PUBLIC_URL

없음 (각 요청에서 파생; 인그레스가 Host를 재작성하는 경우 설정)

명령어: init (브라우저 로그인), run (서비스), logout (저장된 키 제거). init은 --workspace <id>, --allow-writes, --allow-credentials, --ttl-days (기본값 90)를 허용합니다.

플래그

기본값

설명

--transport

stdio

stdio 또는 http

--http-addr

:8080

HTTP 전송의 수신 주소

--allow-writes

false

stdio에 대한 변경 도구를 활성화하고 readonly=false인 HTTP 세션이 쓰기 도구를 등록하도록 허용

개발

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

internal/apiclient 아래의 API 클라이언트는 oapi-codegen을 사용하여 Skycloak OpenAPI 사양에서 생성됩니다.

API와 동기화 유지

internal/apiclient의 클라이언트는 oapi-codegen을 사용하여 internal/apiclient/openapi.yaml에서 생성됩니다. make generate를 실행하여 새로 고칩니다. 커밋된 생성 코드가 사양에서 벗어나면 CI가 실패합니다. 요청은 429/5xx에서 Retry-After 인식 백오프로 재시도됩니다.

배포

각 태그에서 GitHub 바이너리 및 ghcr.io/sky-cloak/skycloak-mcp 컨테이너 이미지로 릴리스되며, MCP 레지스트리에 io.skycloak/skycloak-mcp로 게시됩니다. 대부분의 사람들은 둘 다 필요하지 않습니다. 호스팅된 서버는 설치가 필요 없습니다.

보안

취약점은 비공개로 보고해 주세요. SECURITY.md를 참조하세요.

기여자

Skycloak에서 Guilliano Molaire, Neville Omangi 및 Aphilas가 구축했습니다. 저장소 기록은 공개될 때 스쿼시되었으므로 커밋 로그는 누가 무엇을 작성했는지 반영하지 않습니다.

라이선스

Apache-2.0. internal/apiclient/openapi.yaml의 OpenAPI 설명은 Skycloak 플랫폼 API에서 생성되었으며 (c) Skycloak입니다. 클라이언트를 생성하고 검증할 수 있도록 여기에 포함되었습니다. 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