Skip to content

Create a realm user

POST
/clusters/{cluster_id}/realms/{realm_name}/users
curl --request POST \
  --url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal/users \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta' \
  --header 'Content-Type: application/json' \
  --data '{ "username": "john.doe", "email": "john@example.com", "first_name": "John", "last_name": "Doe", "temporary_password": "ChangeMe123", "enabled": true, "roles": [ "admin" ] }'

Creates a user in the specified realm.

Required scope: realm-users:write

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
cluster_id
required
string format: uuid
realm_name
required

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

string
>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/

Example 

customer-portal

Header Parameters

Section titled “Header Parameters”
API-Version
required
string
Allowed values: 2026-06-01.beta

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Request body for creating a realm user.

object
username
required
string
>= 3 characters <= 255 characters /^[A-Za-z0-9._@-]+$/

Example 

john.doe
email
required
string format: email

Example 

john@example.com
first_name
string
<= 255 characters

Example 

John
last_name
string
<= 255 characters

Example 

Doe
temporary_password
required

Initial password set for the user. Must be at least 8 characters. Additional constraints are enforced by the realm’s Keycloak password policy at the time of creation (e.g. minimum uppercase/lowercase/digit/special-character counts, disallow reuse, disallow username/email as password). Password policy violations return 422 with a message describing the specific rule that was not met.

string format: password
>= 8 characters

Example 

ChangeMe123
enabled

Whether the user can sign in immediately after creation.

boolean
default: true

Example 

true
roles

Realm roles to assign after the user is created.

Array<string>

Example 

[
  "admin"
]

Example 

{
  "username": "john.doe",
  "email": "john@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "temporary_password": "ChangeMe123",
  "enabled": true,
  "roles": [
    "admin"
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

The request has succeeded and a new resource has been created as a result.

Media typeapplication/json

Public representation of a realm user.

object
id
required
string
>= 1 characters <= 255 characters
username
required
string
>= 3 characters <= 255 characters /^[A-Za-z0-9._@-]+$/
email
required
string format: email
first_name
string
last_name
string
enabled
required

Whether the user can sign in.

boolean
email_verified

Whether the email address has been verified.

boolean
organization

Organization associated with the user, when available.

string
last_login_at

Most recent successful sign-in time, when available.

string format: date-time
created_at

Time when the user was created, when available.

string format: date-time

Example 

{
  "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"
}

401

Section titled “401”

Access is unauthorized.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

403

Section titled “403”

Access is forbidden.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

404

Section titled “404”

The server cannot find the requested resource.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

409

Section titled “409”

The request conflicts with the current state of the server.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

422

Section titled “422”

Client error

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
errors
required
Array<object>
>= 1 items
object
field
required
string
detail
required
string
code
string
value

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "errors": [
    {
      "field": "example",
      "detail": "example",
      "code": "example",
      "value": "example"
    }
  ]
}

429

Section titled “429”

Client error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Headers

Section titled “Headers”
Retry-After
integer
RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer
X-RateLimit-Limit-Second
integer
X-RateLimit-Remaining-Second
integer
X-RateLimit-Limit-Minute
integer
X-RateLimit-Remaining-Minute
integer
X-RateLimit-Limit-Hour
integer
X-RateLimit-Remaining-Hour
integer
X-RateLimit-Limit-Day
integer
X-RateLimit-Remaining-Day
integer

500

Section titled “500”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

501

Section titled “501”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}
© 2026 Skycloak. All Rights Reserved. Design by Yasser SolimanKeycloak™ is a trademark of the Linux Foundation. Skycloak is not affiliated with the Keycloak project.