Skip to main content

Request a code to reset a password

POST 
https://$CUSTOM-DOMAIN/v2/users/:userId/password_reset

Request a code to reset a password..

Request​

Path Parameters

    userId stringrequired

Body

required

    sendLink

    object

    notificationType string

    Possible values: [NOTIFICATION_TYPE_Unspecified, NOTIFICATION_TYPE_Email, NOTIFICATION_TYPE_SMS]

    Default value: NOTIFICATION_TYPE_Unspecified

    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.

    The following placeholders can be used: UserID, OrgID, Code

    returnCode object

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)
    creationDate date-time
    verificationCode in case the medium was set to return_code, the code will be returned (string)
curl -L 'https://$CUSTOM-DOMAIN/v2/users/:userId/password_reset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "sendLink": {
    "notificationType": "NOTIFICATION_TYPE_Unspecified",
    "urlTemplate": "https://example.com/password/changey?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
Body required
{
  "sendLink": {
    "notificationType": "NOTIFICATION_TYPE_Unspecified",
    "urlTemplate": "https://example.com/password/changey?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}
ResponseClear

Click the Send API Request button above and see the response here!