Skip to main content

Request password reset

POST 
/resources/v3alpha/users/:id/password/_reset

Request a code to be able to set a new password.

Request​

Path Parameters

    id stringrequired

    unique identifier of the user.

Body

required

    instance

    object

    id string
    domain string

    organization

    object

    Optionally expect the user to be in this organization.

    orgId string
    orgDomain string

    sendEmail

    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 password reset mail sent by ZITADEL to guide the user to your password change page. If no template is set, the default ZITADEL url will be used.

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

Responses​

Password reset successfully requested

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
    verificationCode string

    In case the medium was set to return_code, the code will be returned.

Loading...