メインコンテンツまでスキップ

Reset Password

ユーザーがパスワードリセット要求を行うためのAPIです。コントラクタとアカウントのメールアドレスを指定してリクエストを行います。
リクエストが完了すると、そのメールアドレス宛にパスワードリセットの案内メールが送信されます。案内メールにはリセットトークンが付与されたパスワードリセットページのURLが貼付されます。
*パスワードリセットの有効期限はリクエストが完了してから24時間以内となりますのでご注意ください。

Query Parameters
contractor string REQUIRED

リセットしたいアカウントのコントラクタを指定してください。

Example: playground
email string REQUIRED

リセットするユーザのメールアドレスを指定してください。

Example: sample@example.com
customResetPasswordUrl string

パスワードリセットの案内メールの本文に記載されるURLです。URLが指定されていない場合は、nAuthのインスペクタMAIL_DOMAINをベースURLとして使用してURLが作成されます。

Example: https://newtzero.io/password/rescue
Responses
200

パスワードリセットの案内メールが正常に送信されました。

500

コントラクタにユーザが存在しないか、メールの送信に失敗しています。