Skip to main content

Request a code to reset a password​

Request a code to reset a password

Path Parameters
  • userId string required
Request 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."

  • 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
  • verificationCode in case the medium was set to return_code, the code will be returned
Loading...