5.6. パスワードリセット要求

POST /1/(tenantId)/request_password_reset

パスワードのリセットを行う。

Request Headers:  

• X-Application-Id -- アプリケーションID(必須)
• X-Application-Key -- アプリケーションキー(必須)
• Content-Type -- application/json

Request JSON Object:  

• username (string) -- ユーザ名 (username / email どちらか必須)
• email (string) -- E-mail アドレス (username / email どちらか必須)

Status Codes:

• 200 OK -- パスワードリセットメールを正常に送信した
• 400 Bad Request -- パラメータ/リクエストボディ不正
• 401 Unauthorized -- 認証エラー
• 403 Forbidden -- リクエストリミット超過
• 404 Not Found -- 該当ユーザが存在しない
• 409 Conflict -- 更新が衝突した (request_conflicted)
• 415 Unsupported Media Type -- Content-Type 不正

リクエストボディの例

{
    "username": "tarou",
    "email": "nichiden.tarou@example.com",
}

レスポンス

成功時は空JSON({})が返却される。

409 Conflict の場合は以下のレスポンスボディが返却される。

{
    "reasonCode": "request_conflicted",
    "detail": "Updating conflicted"
}

注意事項

• リセットは攻撃に使われることを考慮して時間内にリクエストできる回数の制限を設ける。(10分に一回)
• _USERS バケットのcontentACLに対する権限は不要。
• 外部認証(LDAP等)連携ユーザ、及びクライアント証明書ユーザに対しては、本機能は使用できない。使用した場合は403エラーを返却する。
• 本人通知メール設定が有効の場合、パスワード更新後、更新したユーザのE-mailアドレス宛に、本人通知メールが送信される。
• パスワード更新が完了した際、該当ユーザのセッショントークンはすべて無効化される。