World Monitor
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 100 tools.
Unofficial: one tool per Keycloak admin operation on a realm, read-only unless writes are enabled
一覧は利用スコア(100 点満点)で並びます。内訳は次のとおり
| 人気 | 28/80 | GitHub スターか週間ダウンロード数。大きい方を 60、小さい方を 20 で数えます |
|---|---|---|
| 新しさ | 12/12 | 30 日以内のリリースかコード更新で満点 |
| 応答中 | 0/8 | 前回の確認でクラウドのエンドポイントが応答 |
| 利用スコア | 40/100 |
品質: 基本チェック 3/3 項目に合格(表示のみ、並び順には不使用) · 勢い: 108 (「急上昇」タブでのみ使用)
使っているAIアプリを選んで、設定をコピーしてください。
ひとことで AI にインストールしてもらう
Keycloak Admin API をインストールして。https://mcp.popnx.com/i/sferarc-keycloak-api-mcp.md に従い、コマンドを見せて、私が OK するまで実行しないで。パソコンで作業できる AI(Claude Code や Cursor など)に貼り付けます。手順を読み、コマンドを見せて、あなたの OK を待ちます。キー不要・登録不要。 · AI が読む全文を見る
チェック 3/3 合格 · あなたのパソコンで動きます · ✓ コマンド確認済み 2026年11月17日
まず:どの AI を使っていますか?
使っているアプリを選ぶと、下に手順が表示されます。
このメッセージを Claude のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Claude に MCP server Keycloak Admin API を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "mcpServers": { "keycloak-api": { "command": "npx", "args": [ "-y", "keycloak-api" ], "env": { "KEYCLOAK_URL": "your-value", "KEYCLOAK_REALM": "your-value", "KEYCLOAK_TOKEN": "your-value", "KEYCLOAK_CLIENT_SECRET": "your-value", "KEYCLOAK_TOKEN_REALM": "your-value" } } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET, KEYCLOAK_TOKEN_REALM, KEYCLOAK_URL, KEYCLOAK_REALM は "your-value" のままにして、本当の値は私がファイルかアプリの入力欄に自分で貼るよう伝える。チャットにキーを書かせない。5) 了承した内容を実行し、Keycloak Admin API のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -vMac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です: node -v
一度入れれば、Node.js を使うすべてのツールで使えます
提供元のサイトで登録し、次の手順で使う API キーを作ります。料金や無料プランは提供元のサイトで確認してください。
これはプログラムの設定でキーではありません。登録は不要で、作者の説明どおりに入力します。
KEYCLOAK_URL サーバーのベース URL。例: https://keycloak.example.com KEYCLOAK_REALM ツールが操作する realm。 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
SettingsDeveloperEdit Config
{
"mcpServers": {
"keycloak-api": {
"command": "npx",
"args": [
"-y",
"keycloak-api"
],
"env": {
"KEYCLOAK_URL": "your-value",
"KEYCLOAK_REALM": "your-value",
"KEYCLOAK_TOKEN": "your-value",
"KEYCLOAK_CLIENT_SECRET": "your-value",
"KEYCLOAK_TOKEN_REALM": "your-value"
}
}
}
}キーはアプリの入力欄にだけ貼り付け、チャットに貼ったり人に送ったりしないでください
Keycloak Admin API を使って、私に何ができるか教えて、1 つやってみせて✓ Claude が Keycloak Admin API を使っていると言うか、回答に Keycloak Admin API のツール名が出れば接続成功です
上のコマンドはこれらがなくても動きます。変えたいときだけ作者の説明に沿って追加してください。
KEYCLOAK_CLIENT_ID A confidential client with a service account, for the client credentials grantKEYCLOAK_MCP_ALLOW_WRITES 1 to list the tools that change dataKEYCLOAK_MCP_RESOURCES ツールを一覧表示する対象リソースのカンマ区切りリスト(例: users,groups,roles) 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
メニュー名は 2026年11月11日 に Anthropic のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
ChatGPT はまだ Keycloak Admin API につなげません
Keycloak Admin API はパソコンに入れて使うものですが、ChatGPT は Web 上で動くサーバーにしかつなげません
A · Keycloak Admin API につなげるアプリを使う
B · その他 の中で ChatGPT につなげる別のサーバー
同じカテゴリでよく使われているものから、キーなしでアドレスだけでつなげるものを選びました
Claude Code につなげますが、先に準備が必要です
Keycloak Admin API のキーが必要です(提供元のサイトで作成) · 設定を 2 項目入力 (KEYCLOAK_URL, KEYCLOAK_REALM) · 先にパソコンへ Node.js を入れてください(1 回だけ)
このメッセージを Claude Code のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Claude Code に MCP server Keycloak Admin API を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):claude mcp add --scope user keycloak-api --env KEYCLOAK_URL=your-value --env KEYCLOAK_REALM=your-value --env KEYCLOAK_TOKEN=your-value --env KEYCLOAK_CLIENT_SECRET=your-value --env KEYCLOAK_TOKEN_REALM=your-value -- npx -y keycloak-api 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET, KEYCLOAK_TOKEN_REALM, KEYCLOAK_URL, KEYCLOAK_REALM は "your-value" のままにして、本当の値は私がファイルかアプリの入力欄に自分で貼るよう伝える。チャットにキーを書かせない。5) 了承した内容を実行し、Keycloak Admin API のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -vMac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です: node -v
一度入れれば、Node.js を使うすべてのツールで使えます
提供元のサイトで登録し、次の手順で使う API キーを作ります。料金や無料プランは提供元のサイトで確認してください。
これはプログラムの設定でキーではありません。登録は不要で、作者の説明どおりに入力します。
KEYCLOAK_URL サーバーのベース URL。例: https://keycloak.example.com KEYCLOAK_REALM ツールが操作する realm。 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
Mac:Command+スペースで Terminal と入力 · Windows:PowerShell を開く
claude mcp add --scope user keycloak-api --env KEYCLOAK_URL=your-value --env KEYCLOAK_REALM=your-value --env KEYCLOAK_TOKEN=your-value --env KEYCLOAK_CLIENT_SECRET=your-value --env KEYCLOAK_TOKEN_REALM=your-value -- npx -y keycloak-apiEnter の前に「your-value」を自分のキーに書き換えてください
キーはアプリの入力欄にだけ貼り付け、チャットに貼ったり人に送ったりしないでください
Keycloak Admin API が一覧にあり、接続済みと表示されれば OK です
Keycloak Admin API を使って、私に何ができるか教えて、1 つやってみせて✓ Claude Code が Keycloak Admin API を使っていると言うか、回答に Keycloak Admin API のツール名が出れば接続成功です
上のコマンドはこれらがなくても動きます。変えたいときだけ作者の説明に沿って追加してください。
KEYCLOAK_CLIENT_ID A confidential client with a service account, for the client credentials grantKEYCLOAK_MCP_ALLOW_WRITES 1 to list the tools that change dataKEYCLOAK_MCP_RESOURCES ツールを一覧表示する対象リソースのカンマ区切りリスト(例: users,groups,roles) 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
メニュー名は 2026年11月11日 に Anthropic のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
Cursor につなげますが、先に準備が必要です
Keycloak Admin API のキーが必要です(提供元のサイトで作成) · 設定を 2 項目入力 (KEYCLOAK_URL, KEYCLOAK_REALM) · 先にパソコンへ Node.js を入れてください(1 回だけ)
このメッセージを Cursor のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Cursor に MCP server Keycloak Admin API を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "mcpServers": { "keycloak-api": { "command": "npx", "args": [ "-y", "keycloak-api" ], "env": { "KEYCLOAK_URL": "your-value", "KEYCLOAK_REALM": "your-value", "KEYCLOAK_TOKEN": "your-value", "KEYCLOAK_CLIENT_SECRET": "your-value", "KEYCLOAK_TOKEN_REALM": "your-value" } } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET, KEYCLOAK_TOKEN_REALM, KEYCLOAK_URL, KEYCLOAK_REALM は "your-value" のままにして、本当の値は私がファイルかアプリの入力欄に自分で貼るよう伝える。チャットにキーを書かせない。5) 了承した内容を実行し、Keycloak Admin API のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -vMac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です: node -v
一度入れれば、Node.js を使うすべてのツールで使えます
提供元のサイトで登録し、次の手順で使う API キーを作ります。料金や無料プランは提供元のサイトで確認してください。
これはプログラムの設定でキーではありません。登録は不要で、作者の説明どおりに入力します。
KEYCLOAK_URL サーバーのベース URL。例: https://keycloak.example.com KEYCLOAK_REALM ツールが操作する realm。 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
Keycloak Admin API の設定で KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET, KEYCLOAK_TOKEN_REALM, KEYCLOAK_URL, KEYCLOAK_REALM が空です。自分のキーを入れて保存します
キーはアプリの入力欄にだけ貼り付け、チャットに貼ったり人に送ったりしないでください
Keycloak Admin API を使って、私に何ができるか教えて、1 つやってみせて✓ Cursor が Keycloak Admin API を使っていると言うか、回答に Keycloak Admin API のツール名が出れば接続成功です
上のコマンドはこれらがなくても動きます。変えたいときだけ作者の説明に沿って追加してください。
KEYCLOAK_CLIENT_ID A confidential client with a service account, for the client credentials grantKEYCLOAK_MCP_ALLOW_WRITES 1 to list the tools that change dataKEYCLOAK_MCP_RESOURCES ツールを一覧表示する対象リソースのカンマ区切りリスト(例: users,groups,roles) 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
メニュー名は 2026年11月11日 に Cursor のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
VS Code につなげますが、先に準備が必要です
Keycloak Admin API のキーが必要です(提供元のサイトで作成) · 設定を 2 項目入力 (KEYCLOAK_URL, KEYCLOAK_REALM) · 先にパソコンへ Node.js を入れてください(1 回だけ)
このメッセージを VS Code のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの VS Code に MCP server Keycloak Admin API を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "servers": { "keycloak-api": { "type": "stdio", "command": "npx", "args": [ "-y", "keycloak-api" ], "env": { "KEYCLOAK_URL": "your-value", "KEYCLOAK_REALM": "your-value", "KEYCLOAK_TOKEN": "your-value", "KEYCLOAK_CLIENT_SECRET": "your-value", "KEYCLOAK_TOKEN_REALM": "your-value" } } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET, KEYCLOAK_TOKEN_REALM, KEYCLOAK_URL, KEYCLOAK_REALM は "your-value" のままにして、本当の値は私がファイルかアプリの入力欄に自分で貼るよう伝える。チャットにキーを書かせない。5) 了承した内容を実行し、Keycloak Admin API のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -vMac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です: node -v
一度入れれば、Node.js を使うすべてのツールで使えます
提供元のサイトで登録し、次の手順で使う API キーを作ります。料金や無料プランは提供元のサイトで確認してください。
これはプログラムの設定でキーではありません。登録は不要で、作者の説明どおりに入力します。
KEYCLOAK_URL サーバーのベース URL。例: https://keycloak.example.com KEYCLOAK_REALM ツールが操作する realm。 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
Keycloak Admin API の設定で KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET, KEYCLOAK_TOKEN_REALM, KEYCLOAK_URL, KEYCLOAK_REALM が空です。自分のキーを入れて保存します
キーはアプリの入力欄にだけ貼り付け、チャットに貼ったり人に送ったりしないでください
Keycloak Admin API を使って、私に何ができるか教えて、1 つやってみせて✓ VS Code が Keycloak Admin API を使っていると言うか、回答に Keycloak Admin API のツール名が出れば接続成功です
上のコマンドはこれらがなくても動きます。変えたいときだけ作者の説明に沿って追加してください。
KEYCLOAK_CLIENT_ID A confidential client with a service account, for the client credentials grantKEYCLOAK_MCP_ALLOW_WRITES 1 to list the tools that change dataKEYCLOAK_MCP_RESOURCES ツールを一覧表示する対象リソースのカンマ区切りリスト(例: users,groups,roles) 説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
メニュー名は 2026年11月11日 に VS Code のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
Claude Code
claude mcp add --scope user keycloak-api --env KEYCLOAK_URL=your-value --env KEYCLOAK_REALM=your-value --env KEYCLOAK_TOKEN=your-value --env KEYCLOAK_CLIENT_SECRET=your-value --env KEYCLOAK_TOKEN_REALM=your-value -- npx -y keycloak-apiClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"keycloak-api": {
"command": "npx",
"args": [
"-y",
"keycloak-api"
],
"env": {
"KEYCLOAK_URL": "your-value",
"KEYCLOAK_REALM": "your-value",
"KEYCLOAK_TOKEN": "your-value",
"KEYCLOAK_CLIENT_SECRET": "your-value",
"KEYCLOAK_TOKEN_REALM": "your-value"
}
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"keycloak-api": {
"command": "npx",
"args": [
"-y",
"keycloak-api"
],
"env": {
"KEYCLOAK_URL": "your-value",
"KEYCLOAK_REALM": "your-value",
"KEYCLOAK_TOKEN": "your-value",
"KEYCLOAK_CLIENT_SECRET": "your-value",
"KEYCLOAK_TOKEN_REALM": "your-value"
}
}
}
}VS Code (mcp.json)
{
"servers": {
"keycloak-api": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"keycloak-api"
],
"env": {
"KEYCLOAK_URL": "your-value",
"KEYCLOAK_REALM": "your-value",
"KEYCLOAK_TOKEN": "your-value",
"KEYCLOAK_CLIENT_SECRET": "your-value",
"KEYCLOAK_TOKEN_REALM": "your-value"
}
}
}
}KEYCLOAK_URL 必須 envKEYCLOAK_REALM 必須 envKEYCLOAK_TOKEN 秘密 必須 envKEYCLOAK_CLIENT_ID envKEYCLOAK_CLIENT_SECRET 秘密 必須 envKEYCLOAK_TOKEN_REALM 秘密 必須 envKEYCLOAK_MCP_ALLOW_WRITES envKEYCLOAK_MCP_RESOURCES env説明は自動翻訳です。変数名は原文のままです。迷ったら原文を確認してください。
この設定は、作者のレジストリ登録情報から作成しています。READMEと違う場合は、READMEに従ってください。
npm: keycloak-apiこのサーバーのつなぎ方と、各アプリの公式ドキュメントに基づきます。2026年11月10日に確認。
パソコン上で動かせるアプリ
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
パソコンで動くサーバーです。インストールすると、ツール一覧がAIアプリに表示されます。
誰でも見られる情報をチェックしており、コードは読んでいません。当てはまらない項目は数に入れていません。 · 2026年11月19日にチェック
レジストリ名は、リポジトリを所有するGitHubアカウント sferarc で確認済みです
コードの最終更新:今日
ISCを使用
これはパソコンで動くため、インターネット上のエンドポイントはありません
パソコンで動き、代わりにローカルの設定を使います
パソコンで動くサーバーです。ツール一覧を読み取れるのは、インターネット上のエンドポイントがある場合だけです
まだ確認していません
作者の方は、このコードを README に貼れます。バッジはこのページにリンクします。
[](https://mcp.popnx.com/en/servers/sferarc-keycloak-api-mcp)質問、コツの共有、使えないことの報告ができます。「役に立った」の多い順です。
まだレビューはありません
レジストリでこのカテゴリにある有効なすべてのサーバーと比較しています。スターは、公開者がリポジトリの所有者である場合だけ数えます。
当てはまる基本チェック3項目のうち3項目に合格しました。コードは読んでいません。キーやトークンを追加する前に、サーバーがどんなアクセスを求めているかを確認し、必要な権限だけを持つキーを使ってください。
入力が必要なもの:KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET, KEYCLOAK_TOKEN_REALM
あなたのパソコンで動きます。必要なときにAIアプリが起動し、データは作者のサーバーを通りません(サーバー自体がオンラインサービスを呼び出す場合を除きます)。
GitHubリポジトリの最終更新は今日、最新バージョン(3.8.1)がレジストリに届いたのは一昨日です。
Claude Desktop、Claude Code、Cursor、VS CodeなどのMCP対応アプリで使えます。パソコンにNode.jsも必要です。
同じカテゴリには:World Monitor, openstatus, Oh My Posh Validator, Strata, Jitsu
同じカテゴリでほかの作者のもの。コマンドは確認済み。公式を先に、次にスター順。
カードの見方:↓ 週あたりのダウンロードi★ GitHubスターi3つの柱:レビュー · チェック · 利用状況i更新=最新バージョンをレジストリに公開した日i
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 100 tools.
Manage monitors, status pages, incidents and maintenances in your openstatus workspace.
Validate oh-my-posh configurations and segment snippets against the official schema.
MCP server for progressive tool usage at any scale (see https://klavis.ai)
Manage Jitsu data pipelines: destinations, streams, connections, functions, live events.
| これ Keycloak Admin API | World Monitor | openstatus | Oh My Posh Validator | Strata | Jitsu | |
|---|---|---|---|---|---|---|
| 動く場所 | パソコンにインストールが必要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 |
| キーが必要 | はい | いいえ | いいえ | いいえ | いいえ | いいえ |
| Claude で + から追加 | いいえ | いいえ | いいえ | いいえ | いいえ | いいえ |
| 基本チェック | 3/3 | 4/4 | 4/4 | 4/4 | 1/4 | 4/4 |
| ライセンス | ISC | AGPL-3.0 | AGPL-3.0 | MIT | Apache-2.0 | MIT |
| 料金 | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし |
作者のリポジトリから書かれたとおりにコピーしたものです。PopNx MCPは内容を確認・推奨していません。HTML、画像、スクリプトは取り除いています。リンクはこのサイトの外へ移動します。
Unofficial. Not made or endorsed by Keycloak.
Auto-generated, fully typed client for the Keycloak Admin and Account REST APIs.
Generated from the admin OpenAPI spec at https://www.keycloak.org/docs-api/latest/rest-api/openapi.json and the account spec kept in this repository at https://raw.githubusercontent.com/sferarc/openapi/main/packages/keycloak-api/specs/account.yaml; before generating, kubb.config.ts renames operation IDs, camel-cases path parameters, sends raw string bodies unquoted and types the workflow resource path parameter as its enum.
fetch, or bring your own implementationkeycloak-api/effectnpm install keycloak-api
Keycloak is self-hosted, so both clients require the baseUrl of your server. Endpoints are addressed as " ".
src/admin/generated/OPERATIONS.md and src/account/generated/OPERATIONS.md list every admin and account operation with its " " request and the spec's summary, one table per tag. They ship in the package, so grep in node_modules/keycloak-api finds an operation without reading the types.
import { KeycloakAdminApi } from "keycloak-api";
const admin = new KeycloakAdminApi({ baseUrl: "https://keycloak.example.com", token: process.env.KEYCLOAK_TOKEN ?? null, });
const realms = await admin.request("GET /admin/realms"); const realm = await admin.request("GET /admin/realms/{realm}", { pathParams: { realm: "master" }, });
The Account API is scoped to a single realm, passed at construction time.
import { KeycloakAccountApi } from "keycloak-api";
const account = new KeycloakAccountApi({ baseUrl: "https://keycloak.example.com", realm: "master", token: process.env.KEYCLOAK_TOKEN ?? null, });
const me = await account.request("GET /account/");
Keycloak access tokens expire after a few minutes. Pass a function as token, sync or async, and both clients call it before every request, so each call sends the token it returns:
const admin = new KeycloakAdminApi({
baseUrl: "https://keycloak.example.com", token: () => tokenStore.getAccessToken(), });
A call rejects with what the function threw, before any request is sent. A call's own config.token still wins.
const admin = new KeycloakAdminApi({
baseUrl: "https://keycloak.example.com", token: process.env.KEYCLOAK_TOKEN ?? null, fetch: myFetchImplementation, });
A call resolves to the parsed body only. To read a response header, pass onResponse in config; it gets the status and headers of the response before the body is read, an error response included. Keycloak answers a create call, such as a new user or client, with 201, an empty body and the new resource's URL, which ends in its id, in Location:
let userId: string | undefined;
await admin.request("POST /admin/realms/{realm}/users", { pathParams: { realm: "master" }, body: { username: "ada", enabled: true }, config: { onResponse: ({ headers }) => (userId = headers.get("Location")?.split("/").pop()) }, });
An error thrown inside onResponse rejects the call with an Error whose message starts with onResponse threw on and whose cause is what was thrown.
A call that gets an HTTP error response rejects with an ApiResponseError, exported from the package, which extends Error: status is the HTTP status code, payload is the parsed JSON error body, or the raw body text, up to 1000 characters, when it is not JSON, and method and path name the request, without its query string. Its message reads returned : , where the detail is the API's own error message or else the first 200 characters of the body. A request that gets no response at all, for example because the network failed, rejects with an Error whose message names the method, the path and the reason, and whose cause is the original exception. A request cancelled through signal rejects with what the signal was aborted with, as is: the AbortError, or the TimeoutError of AbortSignal.timeout().
The effect entrypoint exposes every Admin API operation as an Effect, by tag in AdminApiService and by " " in adminEffectByPath, and every Account API operation in AccountApiService and accountEffectByPath. It requires effect 4 as a peer dependency. As with the client class, the layer needs the baseUrl of your server, and token can be a function that returns a fresh token before every call.
import { Effect } from "effect";
import { adminEffectByPath, makeApiLayer } from "keycloak-api/effect";
const program = adminEffectByPath["GET /admin/realms/{realm}"]({ pathParams: { realm: "master" } });
await Effect.runPromise( program.pipe( Effect.provide( makeApiLayer({ baseUrl: "https://keycloak.example.com", token: () => tokenStore.getAccessToken(), }) ) ) );
Errors are typed as ApiError, NetworkError and ValidationError. An HTTP error response fails with ApiError, which carries the HTTP status; a request that never gets a response, or a token function that throws, fails with NetworkError.
A call can pass its own config, which layers over the layer's: its headers join the layer's, and its other fields, such as onResponse, replace them. An onResponse that throws makes the effect die with the onResponse threw on error as a defect rather than fail with NetworkError.
Account API paths sit under a realm, so an account effect also needs makeAccountLayer(realm), which rebases the server layer's baseUrl onto /realms/ and encodes the realm as KeycloakAccountApi does. One makeApiLayer then serves admin and account effects in the same program:
import { Effect } from "effect";
import { AccountApiService, AdminApiService, makeAccountLayer, makeApiLayer } from "keycloak-api/effect";
const program = Effect.gen(function* () { const realms = yield* AdminApiService.realmsAdmin.gETAdminRealms(); const account = yield* AccountApiService.account .getAccount() .pipe(Effect.provide(makeAccountLayer("my realm"))); return { realms, account }; });
await Effect.runPromise( program.pipe( Effect.provide( makeApiLayer({ baseUrl: "https://keycloak.example.com", token: () => tokenStore.getAccessToken(), }) ) ) );
An account effect run without makeAccountLayer goes to /account/, which is not a Keycloak endpoint.
The package ships keycloak-api-mcp, a stdio MCP server with one tool per admin operation on a realm, so an agent can answer questions such as which users of a realm hold a role. It lists only the read (GET) tools; set KEYCLOAK_MCP_ALLOW_WRITES=1 to add the others, which carry destructiveHint on DELETE. Every tool acts on KEYCLOAK_REALM, which is not a tool argument: the two operations that list and import realms are left out, and a call whose URL resolves outside that realm, such as a group path with .. segments, is refused as a tool error. An HTTP error comes back as a tool error with the status and Keycloak's message.
| Variable | |
|---|---|
KEYCLOAK_URL | Base URL of the server, such as https://keycloak.example.com |
KEYCLOAK_REALM | Realm the tools act on |
KEYCLOAK_TOKEN | A fixed access token, or else: |
KEYCLOAK_CLIENT_ID, KEYCLOAK_CLIENT_SECRET | A confidential client with a service account; the server gets a token with the client credentials grant and renews it before it expires |
KEYCLOAK_TOKEN_REALM | Realm of that client, if not KEYCLOAK_REALM (for example master) |
KEYCLOAK_MCP_ALLOW_WRITES | 1 to list the tools that change data |
KEYCLOAK_MCP_RESOURCES | Comma separated resources to list tools for, such as users,groups,roles: the first path segment after the realm, or realm for the realm itself. Unset lists every resource |
The service account needs the realm-management roles for what the tools should read, such as view-users.
Without KEYCLOAK_MCP_RESOURCES the server lists about 200 read tools, over the 128 a VS Code chat request can enable, so pick the resources there. An unknown name stops the server with the list of valid ones.
Claude Code, in .mcp.json:
{
"mcpServers": { "keycloak": { "command": "npx", "args": ["-y", "-p", "keycloak-api", "keycloak-api-mcp"], "env": { "KEYCLOAK_URL": "https://keycloak.example.com", "KEYCLOAK_REALM": "acme", "KEYCLOAK_CLIENT_ID": "mcp", "KEYCLOAK_CLIENT_SECRET": "${KEYCLOAK_CLIENT_SECRET}" } } } }
VS Code, in .vscode/mcp.json:
{
"inputs": [ { "type": "promptString", "id": "keycloak-secret", "description": "Keycloak client secret", "password": true } ], "servers": { "keycloak": { "type": "stdio", "command": "npx", "args": ["-y", "-p", "keycloak-api", "keycloak-api-mcp"], "env": { "KEYCLOAK_URL": "https://keycloak.example.com", "KEYCLOAK_REALM": "acme", "KEYCLOAK_CLIENT_ID": "mcp", "KEYCLOAK_CLIENT_SECRET": "${input:keycloak-secret}", "KEYCLOAK_MCP_RESOURCES": "users,groups,roles" } } } }
| Import | Contents |
|---|---|
keycloak-api | both client classes, plus admin/account operations, schemas and types |
keycloak-api/admin/components | admin operations grouped by tag and by path |
keycloak-api/admin/schemas | Zod schemas for admin operations |
keycloak-api/admin/types | TypeScript types for admin operations |
keycloak-api/account/components | account operations grouped by tag and by path |
keycloak-api/account/schemas | Zod schemas for account operations |
keycloak-api/account/types | TypeScript types for account operations |
keycloak-api/effect | Effect bindings for admin operations |
ISC