ユーザーの認証器を取り消す
DELETE /v1/users/{user_id}/authenticators/{authenticator_id} · 権限 user-credentials:write
パスキーを含む認証器を 1 つ取り消します。revoked_by は admin:<actor> になり、revoke_reason は admin_removed になります。認証器がすでに取り消されている場合は何も変わらず、呼び出しは引き続き 204 を返します。ユーザーのセッションは終了されません。ユーザーに通知が送信され、この操作は管理監査ログに記録されます。
リクエスト
| パラメーター | 場所 | 必須 | 説明 |
|---|---|---|---|
user_id |
path | はい | ユーザー ID。接頭辞は usr_。 |
authenticator_id |
path | はい | 認証器 ID。接頭辞は cred_。 |
このリクエストにはボディがありません。
レスポンス
204 No Content。認証器がすでに取り消されていた場合も同様です。
エラー
すべてのエラーは、安定した 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 DELETE https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p/authenticators/cred_0a1b2c3d4e5f6g7h8j9k0m1n2p \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
個人データ
このエンドポイントは個人データを扱います：認証情報。KeenAuth APIs の個人データでは、保存される内容、保存期間、削除方法について説明しています。どのフィールドにも、特別な種類の個人データ（健康、生体データ、宗教、政治的意見、性的指向）を送信しないでください。