ユーザーの第二要素をすべてリセット
POST /v1/users/{user_id}/authenticators:reset · 権限 user-credentials:write
ユーザーのすべての第二要素を取り消し、リカバリーコードを削除します。ユーザーは次回サインイン時に要素を登録し直します。include_passkeys の既定値は true です。false を指定すると、パスキー(ロールが both のものを含む)は保持されます。各処理はベストエフォートで実行され、再実行できます。通知に失敗しても呼び出しは失敗しません(notified)。レスポンスには件数のみが含まれ、コードや秘密情報は含まれません。再試行を安全に行うには Idempotency-Key ヘッダーを送信してください。
リクエスト
| パラメーター | 位置 | 必須 | 説明 |
|---|---|---|---|
user_id |
path | はい | ユーザー ID。接頭辞は usr_。 |
任意のボディ:
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
include_passkeys |
boolean | いいえ | 既定値は true。パスキーも取り消されます。false の場合、パスキー(ロールが both のものを含む)は保持されます。 |
locale |
string | いいえ | 通知の BCP 47 言語タグ(例: tr)。既定値はユーザーまたは環境の言語です。 |
レスポンス
200 OK。ボディには実行された処理の件数が含まれます。
{
"revoked_authenticators": 3,
"recovery_codes_deleted": true,
"notified": true
}
エラー
すべてのエラーは、安定した code を含む application/problem+json 形式のボディで返されます。
| HTTP | code |
発生条件 |
|---|---|---|
| 400 | malformed_request, unknown_field |
ボディが有効な JSON ではない、または未知のフィールドが含まれています。 |
| 415 | unsupported_media_type |
Content-Type: application/json を指定せずにボディを送信しました。 |
| 422 | validation_failed |
locale が有効な BCP 47 言語タグではない、またはフィールドの型が不正です。 |
| 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/authenticators:reset \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"include_passkeys": false, "locale": "en"}'
個人データ
このエンドポイントは個人データを扱います:認証情報。KeenAuth API における個人データでは、保存される内容、保存期間、削除方法について説明しています。いかなるフィールドにも特別な種類の個人データ(健康、生体情報、宗教、政治的意見、性的指向)を送信しないでください。