Zustimmung eines Benutzers widerrufen
DELETE /v1/users/{user_id}/consents/{consent_id} · Berechtigung users:write
Widerruft eine OAuth-Zustimmung, die der Benutzer einer Anwendung erteilt hat. Die Refresh-Token-Familien des Benutzers für diese Anwendung werden widerrufen, Access-Tokens, die vor dem Aufruf ausgestellt wurden, werden von Introspection und Widerrufsprüfung nicht mehr akzeptiert, und die nächste Autorisierungsanfrage der Anwendung fragt den Benutzer erneut nach Zustimmung. Die Sitzungen des Benutzers und andere Anwendungen bleiben unberührt. Der Widerruf wird im Verwaltungs-Audit-Log als consent.revoked protokolliert.
Das Widerrufen einer bereits widerrufenen Zustimmung liefert 404 zurück.
Anfrage
| Parameter | In | Pflicht | Beschreibung |
|---|---|---|---|
user_id |
path | ja | Benutzer-ID, Präfix usr_. |
consent_id |
path | ja | Zustimmungs-ID, Präfix cns_ (aus Zustimmungen eines Benutzers auflisten). |
Antwort
204 No Content.
Fehler
Jeder Fehler ist ein application/problem+json-Body mit einem stabilen code.
| HTTP | code |
Wann |
|---|---|---|
| 404 | not_found |
Der Benutzer existiert in dieser Umgebung nicht, oder die Zustimmung existiert nicht, gehört einem anderen Benutzer oder ist bereits widerrufen. |
| 401 | unauthenticated |
Der API-Schlüssel fehlt, ist ungültig oder wurde widerrufen. |
| 403 | insufficient_permissions |
Dem Schlüssel fehlt die Berechtigung users:write. |
| 429 | rate_limited |
Das Ratenlimit wurde überschritten; beachten Sie Retry-After. |
| 503 | service_unavailable |
Eine Abhängigkeit ist vorübergehend nicht verfügbar; versuchen Sie es später erneut. |
Beispiel
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
Personenbezogene Daten
Dieser Endpunkt verarbeitet personenbezogene Daten: Zustimmungsnachweise. Personenbezogene Daten in den KeenAuth-APIs beschreibt, was gespeichert wird, wie lange es aufbewahrt wird und wie es gelöscht wird. Übermitteln Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).