Aller au contenu principal

Supprimer un utilisateur

Ce guide décrit le processus de suppression d'un utilisateur existant de la plateforme Stonal à l'aide de l'API.

Prérequis
  • Un jeu valide d'identifiants API
  • Un jeton d'accès valide (voir : Obtenir un jeton)
  • Un code d'organisation

Étape 1 : Récupérer l'UID de l'utilisateur​

Avant de supprimer un utilisateur, vérifiez qu'il existe afin de garantir que le bon utilisateur sera supprimé.

Voir : Spécification de l'API

POST /v1/organizations/{organizationCode}/users/search

Corps de la requête :

{
  "email": "firstName.lastName@corp.com"
}

Si l'utilisateur existe, vous recevrez une réponse 200 avec les détails de l'utilisateur, y compris son identifiant. Sinon, vous devrez vérifier les informations de l'utilisateur.

Étape 2 : Supprimer l'utilisateur​

Une fois que vous avez confirmé l'existence de l'utilisateur et obtenu son identifiant, vous pouvez procéder à la suppression.

Voir : Spécification de l'API

DELETE /v1/organizations/{organizationCode}/users/{id}

Paramètres de chemin :

  • organizationCode : Code du client (par exemple, "STONAL")
  • id : Identifiant de l'utilisateur à supprimer (par exemple, "123456789")

Réponses possibles :

  • 204 : L'utilisateur a été supprimé avec succès
  • 404 : L'utilisateur à supprimer n'existe pas

Notes​

  • L'opération de suppression est définitive et irréversible
  • Vous devez disposer de l'autorisation appropriée pour supprimer des utilisateurs
  • L'identifiant de l'utilisateur doit être obtenu lors d'une recherche ou d'une récupération d'utilisateur précédente
  • Toutes les autorisations et habilitations de l'utilisateur seront supprimées lors de la suppression

Gestion des erreurs​

Scénarios d'erreur courants :

  • UID de l'utilisateur introuvable
  • Code d'organisation invalide
  • Autorisations insuffisantes pour supprimer des utilisateurs
  • Jeton d'accès invalide ou expiré
  • Problèmes de connectivité réseau

Vérifiez toujours le statut de la réponse et gérez les erreurs de manière appropriée dans votre implémentation.