Skip to main content

Update a user

PUT 
/v3alpha/users/:userId

Update an existing user with data based on a user schema.

Request​

Path Parameters

    userId stringrequired

    unique identifier of the user.

Body

required

    contact

    object

    Add or update the contact information (email, phone) for the user if needed.

    email

    object

    address stringrequired

    Possible values: non-empty and <= 200 characters

    Set the email address.

    sendCode

    object

    Let ZITADEL send the link to the user via email.

    urlTemplate string

    Possible values: non-empty and <= 200 characters

    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.

    returnCode object

    Get the code back to provide it to the user in your preferred mechanism.

    isVerified boolean

    Set the email as already verified.

    phone

    object

    number stringrequired

    Possible values: non-empty and <= 20 characters

    Set the user's phone number.

    sendCode object

    Let ZITADEL send the link to the user via SMS.

    returnCode object

    Get the code back to provide it to the user in your preferred mechanism.

    isVerified boolean

    Set the phone as already verified.

    schemaId string

    Possible values: non-empty and <= 200 characters

    Change the schema the user's data schema by providing it's ID if needed.

    data object

    Update the user data if needed. It will be validated based on the specified schema.

Responses​

User successfully updated

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

    The email code will be set if a contact email was set with a return_code verification option.

    phoneCode string

    The phone code will be set if a contact phone was set with a return_code verification option.

Loading...