Skip to main content

Patch a user

PATCH 
/resources/v3alpha/users/:id

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

Request​

Path Parameters

    id stringrequired

    unique identifier of the user.

Query Parameters

    instance.id string
    instance.domain string
    organization.orgId string
    organization.orgDomain string

Body

required

    schemaId string

    Possible values: non-empty and <= 200 characters

    data object

    contact

    object

    Set the contact information (email, phone) for the user.

    TODO: No SetAuthenticators?

    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.

Responses​

User successfully updated or left unchanged

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id 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...