パスワードリセット - 状態確認 API

概要

{primary} ルートパラメータのトークンの値がパスワードリセット用の値として正しいかを判定します。

受信したパスワードリセット用メールに記載されている、パスワードリセット用URL押下して開いた画面にて最初に本APIにアクセスして状態確認します。

エンドポイント

メソッド URI Headers
GET /api/password/reset/{token} Default

ROUTEパラメータ

パラメーター名 型 内容 特記
token string パスワードリセット用メール送信時に発行したトークン

レスポンス

成功時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 ルートパラメータのトークンの値が正しい場合はtrue
errors array エラーメッセージ 成功のためエラーがないので空配列が返ってきます
alert array アラート 成功のためエラーがないので空配列が返ってきます
data[organization_code] string 監理団体コード 監理団体コード（監理団体IDではない）
data[email] string メールアドレス パスワードリセット用メールを送信したメールアドレス（ログインIDでもある。） 
{
    "data": {
        "organization_code": "1111",
        "email": "dev.cmps@gmail.com"
    },
    "result": true,
    "errors": [],
    "alert": []
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 ルートパラメータのトークンの値が正しくない場合はfalse
errors array エラーメッセージ 発生しているエラーのエラーメッセージが返されます。
alert array アラート アラートは返さないので空配列が返ってきます
data array 返す値が特にないので空配列が返ってきます 
{
    "data": [],
    "result": false,
    "errors": [
        "トークンが不正です。"
    ],
    "alert": []
}