English Français العربية

Keycloak Admin API

السجل الرسمي أخرى

Unofficial: one tool per Keycloak admin operation on a realm, read-only unless writes are enabled

الشيفرة المصدرية الموقع التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package keycloak-api
Claude Code 
claude mcp add keycloak-admin-api -e 'KEYCLOAK_URL=<KEYCLOAK_URL>' -e 'KEYCLOAK_REALM=<KEYCLOAK_REALM>' -e 'KEYCLOAK_TOKEN=<your keycloak_token>' -e 'KEYCLOAK_CLIENT_ID=<KEYCLOAK_CLIENT_ID>' -e 'KEYCLOAK_CLIENT_SECRET=<your keycloak_client_secret>' -e 'KEYCLOAK_TOKEN_REALM=<KEYCLOAK_TOKEN_REALM>' -e 'KEYCLOAK_MCP_ALLOW_WRITES=<KEYCLOAK_MCP_ALLOW_WRITES>' -- npx -y keycloak-api@3.7.1
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "keycloak-admin-api": {
            "command": "npx",
            "args": [
                "-y",
                "keycloak-api@3.7.1"
            ],
            "env": {
                "KEYCLOAK_URL": "<KEYCLOAK_URL>",
                "KEYCLOAK_REALM": "<KEYCLOAK_REALM>",
                "KEYCLOAK_TOKEN": "<your keycloak_token>",
                "KEYCLOAK_CLIENT_ID": "<KEYCLOAK_CLIENT_ID>",
                "KEYCLOAK_CLIENT_SECRET": "<your keycloak_client_secret>",
                "KEYCLOAK_TOKEN_REALM": "<KEYCLOAK_TOKEN_REALM>",
                "KEYCLOAK_MCP_ALLOW_WRITES": "<KEYCLOAK_MCP_ALLOW_WRITES>"
            }
        }
    }
}

متغيرات البيئة

  • 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; otherwise set KEYCLOAK_CLIENT_ID and KEYCLOAK_CLIENT_SECRET
  • KEYCLOAK_CLIENT_ID A confidential client with a service account, for the client credentials grant
  • KEYCLOAK_CLIENT_SECRET سري Secret of that client
  • 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

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

openapi

Type-safe TypeScript clients generated from public OpenAPI specs, plus the site at openapi.sferadev.com that lists them.

PackageAPI
cloudflare-api-jsCloudflare
keycloak-apiKeycloak
litellm-apiLiteLLM
netlify-apiNetlify
nuki-api-jsNuki
v0-apiVercel v0
vercel-api-jsVercel
zoom-api-jsZoom

Coding agents can load skills/openapi-clients, an Agent Skill on picking a client, auth, finding an operation, errors, streaming and Effect: npx skills add sferarc/openapi.

packages/openapi-utils holds the shared kubb config, spec fetching and runtime helpers every client is generated with. apps/openapi is the website.

Development

The toolchain is pinned in mise.toml. With mise installed:

mise install
pnpm install
pnpm tsc && pnpm check && pnpm test
pnpm generate --filter=<package>   # regenerate one client from its live spec

The Update OpenAPI workflow regenerates each client from its upstream spec and opens a PR with a changeset written from the diff. Releases go through changesets: merging the version PR publishes to npm.

الأسئلة الشائعة

ما هو Keycloak Admin API؟

Unofficial: one tool per Keycloak admin operation on a realm, read-only unless writes are enabled

كيف أثبّت Keycloak Admin API؟

يعمل على جهازك. في Claude Code: claude mcp add keycloak-admin-api -e 'KEYCLOAK_URL=<KEYCLOAK_URL>' -e 'KEYCLOAK_REALM=<KEYCLOAK_REALM>' -e 'KEYCLOAK_TOKEN=<your keycloak_token>' -e 'KEYCLOAK_CLIENT_ID=<KEYCLOAK_CLIENT_ID>' -e 'KEYCLOAK_CLIENT_SECRET=<your keycloak_client_secret>' -e 'KEYCLOAK_TOKEN_REALM=<KEYCLOAK_TOKEN_REALM>' -e 'KEYCLOAK_MCP_ALLOW_WRITES=<KEYCLOAK_MCP_ALLOW_WRITES>' -- npx -y keycloak-api@3.7.1. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج Keycloak Admin API إلى مفتاح API؟

نعم. يتطلب KEYCLOAK_URL, KEYCLOAK_REALM, KEYCLOAK_TOKEN, KEYCLOAK_CLIENT_SECRET، وتضبطها في إعداداته.

هل Keycloak Admin API مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص ISC.

من يصون Keycloak Admin API؟

ينشره sferarc. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.