ユーザーのロックを解除
POST /v1/users/{user_id}:unlock · 権限 user-credentials:write
ユーザーの開いているアカウントロックを、すべてのサインイン経路からまとめて解除し、失敗回数を 0 から数え直します。解除された各ロックについて user.unlocked イベント（by = admin）が記録され、管理の監査レコード（user.unlocked）に解除されたロックの一覧が残ります。操作者は、お客様の資格情報です。開いているロックがないユーザーには unlocked: 0 が返り、何も記録されないため、この呼び出しは繰り返しても安全です。単一のロックだけを解除するには、DELETE /v1/attack-protection/lockouts/{lockout_id} を使用してください。
リクエスト
| パラメーター | 場所 | 必須 | 説明 |
|---|---|---|---|
user_id |
パス | はい | usr_ で始まるユーザー ID です。 |
この操作にリクエストボディはありません。
レスポンス
200 OK。
{"unlocked": 2}
unlocked は解除されたロックの数です（サインイン経路ごとに最大 1 件）。
エラー
すべてのエラーは、安定した code を含む application/problem+json ボディです。
| HTTP | code |
発生条件 |
|---|---|---|
| 404 | not_found |
この環境にユーザーが存在しないか、ID の形式が正しくありません。 |
| 401 | unauthenticated |
API キーがないか、無効か、失効しています。 |
| 403 | insufficient_permissions |
キーに user-credentials:write 権限がありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After に従ってください。 |
| 503 | service_unavailable |
依存先のサービスが一時的に利用できません。後で再試行してください。 |
例
curl -X POST https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p:unlock \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
CLI: keenauth users unlock usr_0a1b2c3d4e5f6g7h8j9k0m1n2p