Package Information
Documentation
n8n-nodes-keycloak
An n8n community node for administering Keycloak: users, clients and
OAuth tokens.
Features
- User management — create, read, update, delete, list and search users; reset passwords; send
verification emails; read, add and remove group memberships. - Client management — create, read, update, delete and list clients (applications); read and
regenerate client secrets. - Token minting — password grant and client-credentials grant, with a per-process single-flight
token cache so concurrent executions do not trip Keycloak's brute-force protection. - Error handling — upstream detail is preserved, and credentials are redacted from messages.
Installation
n8n GUI (recommended)
- Go to Settings → Community Nodes → Install.
- Enter
@nonagenticai/n8n-nodes-keycloak.
Manual
npm install @nonagenticai/n8n-nodes-keycloak
Restart n8n afterwards.
Credentials
Create a Keycloak API credential:
| Field | Notes |
|---|---|
| Keycloak Base URL | e.g. https://keycloak.example.com, without a trailing slash. http://localhost:8080 is the default for a local development server. |
| Realm | The realm to authenticate against, e.g. master or your own realm. |
| Username / Password | A realm user with permission to administer it. |
| Client ID | admin-cli unless your realm requires a dedicated client. |
| Client Secret | Optional. Used only by Token → Mint Client Credentials when that operation's own client-secret field is empty. Never sent on admin calls. |
| SSL Certificate Options | Enable Ignore SSL Issues only for a self-signed development server. |
The credential test obtains a real admin token with the password grant and reads the realm, so it
fails for a reachable server whose credentials or realm are wrong.
Operations
User (10)
Create · Get · List · Update · Delete · Reset Password · Send Verify Email · Get Groups ·
Add to Group · Remove from Group
Client (7)
Create · Get · List · Update · Delete · Get Secret · Regenerate Secret
Token (2)
Mint Password Grant · Mint Client Credentials — the latter can refuse a token that carries notenant_id claim, which turns a silently mis-tenanted service account into a loud failure at mint
time.
Examples
Create a user
Resource: User
Operation: Create
Username: john.doe
Email: john.doe@example.com
Enabled: true
Create a client
Resource: Client
Operation: Create
Client ID: my-app
Root URL: https://app.example.com
Additional Fields:
- Public Client: false
- Standard Flow Enabled: true
- Redirect URIs: https://app.example.com/callback
Regenerate a client secret
Resource: Client
Operation: Regenerate Secret
Client ID: <client-uuid>
Development
npm install
npm run build # tsc + icon copy
npm run lint
npm test
npm run dev # tsc --watch
npm run build emits dist/, which is what the n8n block in package.json points at.
Troubleshooting
- Authentication failed — check the base URL, realm and credentials; confirm the user has the
realm-management roles it needs. - Resource not found — user and client identifiers are UUIDs, not usernames or
clientId
values. - Cannot connect — the node must be able to reach the base URL from where n8n runs. A container
cannot reach the host'slocalhost.
API coverage
19 operations over the Keycloak Admin REST API and the OIDC token endpoint. The full specification
this node is validated against is vendored askeycloak-admin-api-openapi.json, andnode validate_openapi_compliance.js checks the implemented endpoints against it.
Links
Security
Report vulnerabilities privately through the repository's Security tab — seeSECURITY.md. Do not open a public issue for a security problem.
Contributing
Issues and pull requests are welcome. See CONTRIBUTING.md for the
development commands and the commit conventions. Commits carry DCO sign-off.