L’API On-Premises ne sera bientôt plus disponible. Consultez notre document Abandon progressif de l’API On-Premises pour de plus amples détails, mais aussi pour connaître la procédure de migration vers notre API Cloud nouvelle génération.

Déconnexion

/v1/users/logout

Utilisez le point de terminaison /v1/users/logout pour vous déconnecter du client de l’API WhatsApp Business. La déconnexion annule le token d’authentification.

Avant de commencer

  • Se déconnecter du client de l’API WhatsApp Business révoque explicitement le token d’authentification envoyé avec la requête. Tous les autres tokens associés au même nom d’utilisateur·ice restent valables.
  • Si vous souhaitez déconnecter un utilisateur ou une utilisatrice, ou annuler son token, utilisez plutôt le point de terminaison DELETE /v1/users. Cette action supprime l’utilisateur·ice du système.

Création

Un utilisateur ou une utilisatrice peut créer une requête de déconnexion en effectuant un appel POST vers ce point de terminaison.

Exemple

POST /v1/users/logout
Authorization: Bearer your-auth-token

La réponse à la requête de déconnexion contient un objet meta dans le corps de la réponse.

Code de réponse HTTPRésultat

200 OK

Réussite : la demande a été validée et l’utilisateur ou l’utilisatrice est déconnecté·e du compte.

401 Unauthorized

Erreur : la demande n’a pas été validée et l’utilisateur ou l’utilisatrice n’est pas déconnecté·e du compte. Un code d’erreur et des informations présenteront les raisons possibles de l’erreur, telles que des identifiants non valides.

Erreurs

S’il y a des erreurs dans la réponse, consultez les sources suivantes pour plus d’informations :