Point de terminaison RÉVOCATION - Amazon Cognito

Point de terminaison RÉVOCATION

Le point de terminaison /oauth2/revoke révoque tous les jetons d'accès que le jeton d'actualisation spécifié a générés. Une fois que le point de terminaison a révoqué les jetons, vous ne pouvez pas utiliser les jetons révoqués pour accéder aux API authentifiées par les jetons Amazon Cognito.

POST /oauth2/revoke

Le point de terminaison /oauth2/revoke prend uniquement en charge HTTPS POST. Le client du groupe d'utilisateurs adresse les demandes directement à ce point de terminaison, et non via le navigateur du système.

Paramètres de demande dans l'en-tête

Autorisation

Si votre client d'application possède un secret client, l'application doit transmettre ses paramètres client_id et client_secret dans l'en-tête d'autorisation via une autorisation HTTP de base. Le secret est Basic Base64Encode(client_id:client_secret).

Content-Type

Doit toujours être 'application/x-www-form-urlencoded'.

Paramètres de la demande dans le corps

token

Jeton d'actualisation que le client veut révoquer. La demande révoque également tous les jetons d'accès émis par Amazon Cognito à partir de ce jeton d'actualisation.

Obligatoire.

client_id

L'ID du client de l'application pour le jeton que vous voulez révoquer.

Obligatoire si le client est public et n'a pas de secret.

Exemples de demandes de révocation

Exemple #1 : Révoquer un jeton pour un client d'application sans secret client

POST /oauth2/revoke HTTP/1.1 Host: https://mydomain.auth.us-east-1.amazoncognito.com Accept: application/json Content-Type: application/x-www-form-urlencoded token=2YotnFZFEjr1zCsicMWpAA& client_id=djc98u3jiedmi283eu928

Exemple #2 : Révoquer un jeton pour un client d'application avec un secret client

POST /oauth2/revoke HTTP/1.1 Host: https://mydomain.auth.us-east-1.amazoncognito.com Accept: application/json Content-Type: application/x-www-form-urlencoded Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW token=2YotnFZFEjr1zCsicMWpAA
Réponse d'erreur Révocation

Une réponse réussie contient un corps vide. La réponse d'erreur est un objet JSON avec un champ error et, dans certains cas, un champ error_description.

Erreurs de point de terminaison

  • Si le jeton n'est pas présent dans la demande ou si la fonction est désactivée pour le client d'application, vous recevez HTTP 400 et l'erreur invalid_request.

  • Si le jeton envoyé par Amazon Cognito dans la demande de révocation n'est pas un jeton d'actualisation, vous recevez HTTP 400 et l'erreur unsupported_token_type.

  • Si les informations d'identification du client ne sont pas valides, vous recevez HTTP 401 et l'erreur invalid_client.

  • Si le jeton a été révoqué ou si le client a soumis un jeton non valide, vous recevez HTTP 200 OK.