Révoquer un authentificateur d'utilisateur
DELETE /v1/users/{user_id}/authenticators/{authenticator_id} · autorisation user-credentials:write
Révoque un authentificateur, clés d'accès comprises. revoked_by devient admin:<actor> et revoke_reason devient admin_removed. Si l'authentificateur est déjà révoqué, rien ne change et l'appel renvoie tout de même 204. Les sessions de l'utilisateur ne sont pas fermées. L'utilisateur est notifié et l'action est consignée dans le journal d'audit de gestion.
Requête
| Paramètre | Emplacement | Obligatoire | Description |
|---|---|---|---|
user_id |
path | oui | Identifiant de l'utilisateur, préfixé usr_. |
authenticator_id |
path | oui | Identifiant de l'authentificateur, préfixé cred_. |
La requête ne comporte pas de corps.
Réponse
204 No Content, y compris lorsque l'authentificateur était déjà révoqué.
Erreurs
Chaque erreur est un corps application/problem+json avec un code stable.
| HTTP | code |
Quand |
|---|---|---|
| 404 | not_found |
L'utilisateur ou l'authentificateur n'existe pas dans cet environnement, l'authentificateur n'appartient pas à cet utilisateur, ou un identifiant est mal formé. |
| 401 | unauthenticated |
La clé API est absente, invalide ou révoquée. |
| 403 | insufficient_permissions |
La clé ne dispose pas de l'autorisation user-credentials: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/authenticators/cred_0a1b2c3d4e5f6g7h8j9k0m1n2p \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
Données personnelles
Cet point de terminaison traite des données personnelles : identifiants. 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.