Aller au contenu principal

Delete User API Key

DELETE 
/company/apikey/:tempCode

Supprime définitivement une clé API créée par l'utilisateur authentifié, révoquant l'accès programmatique associé à ces identifiants.

Objectif​

Permettre aux utilisateurs de révoquer leurs propres clés API lorsqu'elles ne sont plus nécessaires ou lorsqu'on soupçonne qu'elles ont été compromises.

Cas d'utilisation​

  • Révoquer l'accès d'une intégration abandonnée
  • Supprimer une clé compromise ou divulguée accidentellement
  • Faire tourner les identifiants en supprimant l'ancienne et en créant une nouvelle
  • Nettoyer les clés de test qui ne sont plus utilisées

Flux opérationnel​

flowchart TD
  A[Reçoit une requête DELETE] --> B{Utilisateur Authentifié?}
  B -->|Non| C[401 Unauthorized]
  B -->|Oui| D{Utilisateur Existe?}
  D -->|Non| E[404 USER_NOT_FOUND]
  D -->|Oui| F{temp_code Fourni?}
  F -->|Non| G[400 TEMP_CODE_NOT_PROVIDED]
  F -->|Oui| H{La Clé API Existe?}
  H -->|Non| I[404 APIKEY_NOT_FOUND]
  H -->|Oui| J{La Clé Appartient à l'Utilisateur?}
  J -->|Non| K[401 CANT_DELETE]
  J -->|Oui| L[Suppression Logique de la Clé]
  L --> M[200 APIKEY_DELETED]

Considérations importantes​

  • Seules les clés appartenant à l'utilisateur peuvent être supprimées
  • Utiliser le temp_code (et non la clé réelle) pour identifier la clé API
  • La suppression est une suppression logique (plugin mongoose-delete)
  • La clé supprimée n'apparaîtra plus dans les listages futurs
  • La suppression ne peut pas être annulée via l'API publique

Format du temp_code​

  • Chaîne alphanumérique d'environ 25 caractères
  • Exemple : `2c3srejxqa176128918935

Request​

Responses​

Clé API supprimée avec succès

Response Headers