コンテンツにスキップ

Admin API:パスワードの再設定

パスワードを決め直すためのメールを送る操作です。共通の決まり(認証、エラーの形、日時)は Admin API のリファレンス にあります。

例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。

操作 メソッドとパス
パスワードの再設定のメールを送る POST /admin/api/auth/password-reset

パスワードの再設定のメールを送る

Section titled “パスワードの再設定のメールを送る”

登録があり、送る回数の上限の中なら、パスワードを決めるリンクをメールで送る。登録がない、上限に達した、のどれでも同じ 202 を返す(登録の有無を知られないため)。同じ IP からの申し込みが多すぎれば 429。

POST /admin/api/auth/password-reset
  • ログイン:不要

リクエストの本文(application/json):

名前 型 必須 決まり 説明
email 文字列 ○ パスワードを忘れたアカウントのメールアドレス

返る値:

状態 本文
202 オブジェクト(application/json)

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例:

ターミナルウィンドウ
curl -X POST "https://<ホスト名>.hakocms.net/admin/api/auth/password-reset" \
-H "Content-Type: application/json" \
-d '{
"email": "<email>"
}'