Realm Users

List realm users

Returns users in the specified realm.

Required scope: realm-users:read

get/clusters/{cluster_id}/realms/{realm_name}/users

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm_name}/users
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required
realm_namestring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

Example:customer-portal

Query parameters

searchstring
status'all' | 'enabled' | 'disabled'
limitinteger
offsetinteger
order'asc' | 'desc'

Sort direction.

Headers

API-Version'2026-06-01.beta' required

Response

The request has succeeded.

idstring required
usernamestring required

Realm username. Allows letters, digits, dots, hyphens, underscores, and @.

emailstring email required
first_namestring
last_namestring
enabledboolean required

Whether the user can sign in.

email_verifiedboolean

Whether the email address has been verified.

organizationstring

Organization associated with the user, when available.

last_login_atstring date-time

Most recent successful sign-in time, when available.

created_atstring date-time

Time when the user was created, when available.

Example response

[
  {
    "id": "9f3f2e5c-9e3d-4b1d-9f53-2a8af5a5d9a1",
    "username": "john.doe",
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "enabled": true,
    "email_verified": true,
    "organization": "Acme Corp"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.