How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Keycloak

Keycloak Users API

Manage users within a realm

Documentation Provider Profile APIs.io OpenAPI GitHub

Keycloak Users API is one of 6 APIs that Keycloak publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, and 3 JSON Schemas.

This API exposes 13 operations across 7 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 26.0.0.

Requests are made against a single base URL, https://{host}/admin/realms.

13 operations 7 paths 4 schemas 3 DELETE5 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.0.0
Server
https://{host}/admin/realms
Authentication
HTTP Bearer
Contact
Keycloak
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

Keycloak Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Access token obtained from the Keycloak token endpoint. Use the master realm admin credentials or a service account with appropriate realm-management roles.

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 3 DELETE, 5 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 13

Manage users within a realm

GET
/{realm}/users
Keycloak List users
getUsers 10 params → 200
POST
/{realm}/users
Keycloak Create a new user
createUser 1 param body → 201409
GET
/{realm}/users/{userId}
Keycloak Get a user
getUser 2 params → 200404
PUT
/{realm}/users/{userId}
Keycloak Update a user
updateUser 2 params body → 204404
DELETE
/{realm}/users/{userId}
Keycloak Delete a user
deleteUser 2 params → 204404
GET
/{realm}/users/{userId}/role-mappings/realm
Keycloak Get realm-level role mappings for a user
getUserRealmRoleMappings 2 params → 200
POST
/{realm}/users/{userId}/role-mappings/realm
Keycloak Add realm-level role mappings to a user
addUserRealmRoleMappings 2 params body → 204
DELETE
/{realm}/users/{userId}/role-mappings/realm
Keycloak Remove realm-level role mappings from a user
deleteUserRealmRoleMappings 2 params body → 204
GET
/{realm}/users/{userId}/groups
Keycloak Get groups for a user
getUserGroups 2 params → 200
PUT
/{realm}/users/{userId}/groups/{groupId}
Keycloak Add a user to a group
addUserToGroup 3 params → 204
DELETE
/{realm}/users/{userId}/groups/{groupId}
Keycloak Remove a user from a group
removeUserFromGroup 3 params → 204
PUT
/{realm}/users/{userId}/reset-password
Keycloak Reset a user's password
resetUserPassword 2 params body → 204
GET
/{realm}/groups/{groupId}/members
Keycloak Get members of a group
getGroupMembers 4 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UserRepresentation (19 properties), RoleRepresentation (8 properties), GroupRepresentation (7 properties), CredentialRepresentation (6 properties). Each schema is shown below with its type and property counts.

UserRepresentation
object
Representation of a Keycloak user
19 properties
RoleRepresentation
object
Representation of a role in Keycloak
8 properties
GroupRepresentation
object
Representation of a user group in Keycloak
7 properties
CredentialRepresentation
object
Representation of a user credential
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keycloak-users-api-openapi.yml Raw ↑

Other APIs Keycloak publishes across the network.

Keycloak Clients API
AE Profile APIs.io
Keycloak Groups API
AE Profile APIs.io
Keycloak Identity Providers API
AE Profile APIs.io
Keycloak Realms API
AE Profile APIs.io
Keycloak Roles API
AE Profile APIs.io
#User
← Back to K APIs
API Details
ID
keycloak:keycloak-users-api
Server
https://{host}/admin/realms
Docs
https://www.keycloak.org/docs-api/latest/rest-api/
Provider
Keycloak
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=keycloak-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/keycloak-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Keycloak Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.