Skip to main content

Update User

PUT 
/v2beta/users/:userId

Update all information from a user.

Request​

Path Parameters

    userId stringrequired

Query Parameters

    username string
    profile.givenName stringrequired
    profile.familyName stringrequired
    profile.nickName string
    profile.displayName string
    profile.preferredLanguage string
    profile.gender string

    Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]

    Default value: GENDER_UNSPECIFIED

    email.email stringrequired
    email.sendCode.urlTemplate string

    "Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used."

    email.isVerified boolean
    phone.phone string
    phone.isVerified boolean
    password.password.password stringrequired
    password.password.changeRequired boolean
    password.hashedPassword.hash stringrequired

    "Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets"

    password.hashedPassword.changeRequired boolean
    password.currentPassword stringrequired
    password.verificationCode stringrequired

    "the verification code generated during password reset request"

Responses​

OK

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
    emailCode string
    phoneCode string
Loading...