Skip to main content

Create

POST 
/admin/realms/:realmId/users

Creates a new User.

Request​

Path Parameters

    realmId stringrequired

    The realm's id

Body

required
    username string

    The username of the user.

    credentials object[]

    Key-pair collection that is used to set the user password.

  • Array [
    • type string

    The property type (set to "password" to define the user password ).

    value string

    The property value (the user's password if the "type" field is set to "password").

  • ]
    • enabled boolean

    Boolean representing if user is enabled or not. Not to be confused with the emailVerified field that represents whether the user has verified the email. Recommended to set this field to true by default and update to false to disable the user.

    emailVerified boolean

    Informs if the email of the user has been verified. Can be set to false initially and will be set to true once the new users verify their email addresses.

    firstName string

    The first name of the user.

    lastName string

    The last name of the user.

Responses​

OK

Loading...