Zum Hauptinhalt springen

Delete User API Key

DELETE 
/company/apikey/:tempCode

Löscht dauerhaft einen API-Schlüssel, der vom authentifizierten Benutzer erstellt wurde, und widerruft den programmatischen Zugriff, der mit diesen Anmeldedaten verbunden ist.

Ziel​

Benutzern ermöglichen, ihre eigenen API-Schlüssel zu widerrufen, wenn diese nicht mehr benötigt werden oder der Verdacht besteht, dass sie kompromittiert wurden.

Anwendungsfälle​

  • Zugriff einer eingestellten Integration widerrufen
  • Einen kompromittierten oder versehentlich geleakten Schlüssel löschen
  • Anmeldedaten rotieren, indem der alte Schlüssel gelöscht und ein neuer erstellt wird
  • Testschlüssel bereinigen, die nicht mehr verwendet werden

Ablauf​

flowchart TD
  A[DELETE-Anfrage empfangen] --> B{Benutzer authentifiziert?}
  B -->|Nein| C[401 Unauthorized]
  B -->|Ja| D{Benutzer existiert?}
  D -->|Nein| E[404 USER_NOT_FOUND]
  D -->|Ja| F{temp_code angegeben?}
  F -->|Nein| G[400 TEMP_CODE_NOT_PROVIDED]
  F -->|Ja| H{API-Schlüssel existiert?}
  H -->|Nein| I[404 APIKEY_NOT_FOUND]
  H -->|Ja| J{Gehört Schlüssel zum Benutzer?}
  J -->|Nein| K[401 CANT_DELETE]
  J -->|Ja| L[Soft Delete des Schlüssels]
  L --> M[200 APIKEY_DELETED]

Wichtige Hinweise​

  • Es können nur eigene Schlüssel des Benutzers gelöscht werden.
  • Zur Identifikation des API-Schlüssels wird der temp_code verwendet (nicht der eigentliche Schlüssel).
  • Die Löschung ist ein Soft Delete (mongoose-delete Plugin).
  • Der gelöschte Schlüssel erscheint nicht mehr in zukünftigen Auflistungen.
  • Die Löschung kann über die öffentliche API nicht rückgängig gemacht werden.

Format des temp_code​

  • Alphanumerische Zeichenkette von ca

Request​

Responses​

API-Schlüssel erfolgreich gelöscht.

Response Headers