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

SetNewPassword

パスワードを再登録する

Description​

  • ログインしていない状態でのパスワードを変更します。

  • 前提条件として、変更用のパスワード初期化用のIDが必要です。

  • Hexabase社より発行されたemail_templates_idを指定することで、独自のSendgridメールテンプレートを利用することができます。

  • Dynamic Templatesを使うことで、任意の動的な値をテンプレートに渡せます。

Method​

PUT

Request URL Format​

/api/v0/users/password/forgot

Payload​

{
  "new_password":"", // 必須　新規作成パスワード　例：test
  "confirm_password":"",  //必須　確認用パスワード 例：test この値は新規作成の値と同じでなければならない
  "id":"",  //必須　パスワード初期化開始のapi送信後にemailのリンク内部に埋め込まれた情報をここに入れる
  "send_password_to_email": true  // API実行時に登録完了メールを送信する。デフォルト false
  "sender_address": "[email protected]", // 登録完了メールのfromアドレスを任意の値に変更したい場合に指定します
  "sender_name": "Hexabase", // 登録完了メールのfrom名前を任意の値に変更したい場合に指定します
  "no_confirm_email": false,  //省略可。trueを指定すると、confirmメールを送信しなくなります。
  "email_templates_id" : "5fb205b03545feade82dxxxx",  // 登録完了メールを送信する際にお客様用のSendgridテンプレートを使用する場合に設定します。事前にHexabase社へ必要事項を連絡し、Hexabase社より発行されたemail設定IDを指定します。 省略するとHexabaseのデフォルトの登録完了画面が利用されます。
}

Request URL Sample​

PUT https://api.xxx.com/api/v0/users/password/forgot

Response Sample​

なし

Dynamic Templates​

SendGirdのDynamic Templates機能を使うことで、任意の動的な値をテンプレートに渡せます。

Payloadを以下のように指定することで、テンプレートの{{host}}部分に値を設定できます。

{
    "new_password": "",
    "confirm_password": "",
    "id": "",
    "email_templates_id": "5fb205b03545feade82dxxxx",
    "send_password_to_email": true,
    "dynamic_template_data: {
        "host": "template_value"
    },
}

※Dynamic Templatesを使用する場合は、サービス運営会社での設定が必要です。