ユーザーの同意を取り消す
DELETE /v1/users/{user_id}/consents/{consent_id} · 権限 users:write
ユーザーがアプリケーションに与えた OAuth の同意を取り消します。そのアプリケーションに対するユーザーのリフレッシュトークンファミリーは取り消され、呼び出し前に発行されたアクセストークンは、イントロスペクションと失効チェックで受け付けられなくなります。アプリケーションが次に認可リクエストを行うと、ユーザーに再び同意を求めます。ユーザーのセッションや他のアプリケーションには影響しません。この取り消しは consent.revoked として管理監査ログに記録されます。
すでに取り消されている同意を取り消そうとすると、404 が返されます。
リクエスト
| パラメーター | 場所 | 必須 | 説明 |
|---|---|---|---|
user_id |
path | はい | ユーザー ID。接頭辞は usr_。 |
consent_id |
path | はい | 同意 ID。接頭辞は cns_（ユーザーの同意を一覧表示から取得）。 |
レスポンス
204 No Content。
エラー
すべてのエラーは、安定した code を含む application/problem+json ボディで返されます。
| HTTP | code |
発生条件 |
|---|---|---|
| 404 | not_found |
この環境にユーザーが存在しない、または同意が存在しない、別のユーザーに属している、もしくはすでに取り消されている。 |
| 401 | unauthenticated |
API キーが存在しない、無効、または取り消されている。 |
| 403 | insufficient_permissions |
キーに users:write 権限がない。 |
| 429 | rate_limited |
レート制限を超えた。Retry-After に従ってください。 |
| 503 | service_unavailable |
依存サービスが一時的に利用できない。後で再試行してください。 |
例
curl -X DELETE https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p/consents/cns_01jb2k8m5c3f6t9w2y4b7d0g3k \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
CLI: keenauth users consents delete usr_0a1b2c3d4e5f6g7h8j9k0m1n2p cns_01jb2k8m5c3f6t9w2y4b7d0g3k --yes
個人データ
このエンドポイントは個人データを扱います：同意の記録。KeenAuth APIs の個人データでは、保存される内容、保存期間、削除方法について説明しています。どのフィールドにも、特別な種類の個人データ（健康、生体データ、宗教、政治的意見、性的指向）を送信しないでください。