ユーザーにパスワードのリセットを強制する
POST /v1/users/{user_id}:force-password-reset · 権限 user-credentials:write
ユーザーに新しいパスワードの設定を求めます。ユーザーが次回パスワードでのサインインに成功した後は、新しいパスワードを設定するまで先に進めません。現在のパスワードハッシュは削除されません。ユーザーは既存のパスワードで一度だけサインインし、その後に新しいパスワードを設定します。再度呼び出しても安全です。ユーザーがすでにフラグ付けされている場合は、最初のフラグ付けの時刻が保持されます。この操作は管理の監査ログ（user.password_reset_forced）に記録され、password_reset.scheduled イベントを発行します。多数のユーザーをまとめてフラグ付けするには、一括パスワードリセットジョブを作成する を使用してください。
リクエストにボディは不要です（何も送信しないか、{} を送信してください）。再試行を安全にするには、Idempotency-Key ヘッダーを送信してください。
リクエスト
| パラメーター | 場所 | 必須 | 説明 |
|---|---|---|---|
user_id |
パス | はい | usr_ で始まるユーザー ID です。 |
レスポンス
204 No Content。
エラー
すべてのエラーは、安定した code を含む application/problem+json ボディです。
| HTTP | code |
発生条件 |
|---|---|---|
| 400 | malformed_request, unknown_field |
ボディが有効な JSON ではないか、未知のフィールドがあります。 |
| 401 | unauthenticated |
API キーがないか、無効か、失効しています。 |
| 403 | insufficient_permissions |
キーに user-credentials:write 権限がありません。 |
| 404 | not_found |
この環境にユーザーが存在しないか、ID の形式が正しくありません。 |
| 409 | conflict |
ユーザーにパスワードがありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After に従ってください。 |
| 503 | service_unavailable |
依存先のサービスが一時的に利用できません。後で再試行してください。 |
例
curl -X POST https://api.eu.keenauth.com/v1/users/usr_01h455vb4pex5vsknk084sn02q:force-password-reset \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)"
CLI: keenauth users force-password-reset usr_01h455vb4pex5vsknk084sn02q