Révoquer le consentement d'un utilisateur

DELETE /v1/users/{user_id}/consents/{consent_id} · autorisation users:write

Révoque un consentement OAuth accordé par l'utilisateur à une application. Les familles de jetons d'actualisation de l'utilisateur pour cette application sont révoquées, les jetons d'accès émis avant l'appel cessent d'être acceptés par l'introspection et par la vérification de révocation, et la prochaine demande d'autorisation de l'application demande à nouveau le consentement de l'utilisateur. Les sessions de l'utilisateur et ses autres applications ne sont pas affectées. La révocation est consignée dans le journal d'audit de gestion sous consent.revoked.

Révoquer un consentement déjà révoqué renvoie 404.

Requête

Paramètre Emplacement Obligatoire Description
user_id path oui Identifiant de l'utilisateur, préfixé usr_.
consent_id path oui Identifiant du consentement, préfixé cns_ (issu de Lister les consentements d'un utilisateur).

Réponse

204 No Content.

Erreurs

Chaque erreur est un corps application/problem+json avec un code stable.

HTTP code Quand
404 not_found L'utilisateur n'existe pas dans cet environnement, ou le consentement n'existe pas, appartient à un autre utilisateur ou est déjà révoqué.
401 unauthenticated La clé API est absente, invalide ou révoquée.
403 insufficient_permissions La clé ne dispose pas de l'autorisation users:write.
429 rate_limited La limite de débit a été dépassée ; respectez Retry-After.
503 service_unavailable Une dépendance est temporairement indisponible ; réessayez plus tard.

Exemple

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

Données personnelles

Cet point de terminaison traite des données personnelles : enregistrements de consentement. Données personnelles dans les API KeenAuth décrit ce qui est stocké, pendant combien de temps et comment elles sont supprimées. N'envoyez de catégories particulières de données personnelles (santé, données biométriques, religion, opinions politiques, orientation sexuelle) dans aucun champ.