Skip to main content

Update

PUT 
/admin/realms/:realmId/users

Updates a given User.

Request​

Path Parameters

    realmId stringrequired

    The realm's id.

    userId stringrequired

    The user'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

Schema
    id string

    The id of the user.

    origin string
    createdTimestamp number
    username string

    The username of the user.

    enabled boolean

    Boolean representing if user is enabled or not.

    totp boolean

    Boolean representing if time-based OTP is enabled or not.

    emailVerified boolean

    Informs if the email of the user has been verified.

    firstName string

    The first name of the user.

    lastName string

    The last name of the user.

    email string

    The email of the user.

    serviceAccountClientId string
    groups array
    requiredActions array

    Possible values: [VERIFY_EMAIL, UPDATE_PROFILE, CONFIGURE_TOTP, UPDATE_PASSWORD, TERMS_AND_CONDITIONS]

    Actions a user must perform during the authentication process.

Loading...