Zum Hauptinhalt springen

Get User API Keys

GET 
/company/apikey/

Ruft alle API-Schlüssel ab, die vom authentifizierten Benutzer erstellt wurden, und ermöglicht die Überprüfung und Verwaltung der eigenen programmatischen Zugangsdaten.

Ziel​

Dem Benutzer Einblick in seine aktiven API-Schlüssel geben, einschließlich ihrer Typen und der temporären Codes, die für die Löschung erforderlich sind.

Anwendungsfälle​

  • Überprüfen, welche API-Schlüssel für den Benutzer aktiv sind
  • Den für die Löschung eines bestimmten Schlüssels erforderlichen temp_code abrufen
  • Den Berechtigungstyp jedes Schlüssels überprüfen
  • Alte Schlüssel identifizieren, die ausgetauscht werden sollten

Ablauf​

  1. Prüft, ob der Benutzer existiert und zu einem Unternehmen gehört
  2. Sucht alle dem Benutzer zugeordneten Schlüssel
  3. Maskiert die Schlüssel teilweise aus Sicherheitsgründen (zeigt die ersten 8 und letzten 4 Zeichen)
  4. Gibt die Liste der Schlüssel mit ihren Metadaten zurück

Maskierungsmechanismus​

API-Schlüssel werden teilweise angezeigt:

  • Format: sk_live_*****5678 (erste 8 Zeichen + Sternchen + letzte 4 Zeichen)
  • Vollständige Schlüssel werden nur zum Zeitpunkt der Erstellung angezeigt
  • Eine vollständige Wiederherstellung des Schlüssels ist später nicht möglich

Wichtige Hinweise​

  • Es werden nur die eigenen Schlüssel des Benutzers zurückgegeben (nicht die anderer Benutzer des Unternehmens)
  • Gelöschte Schlüssel (Soft Delete) erscheinen nicht in der Liste
  • Das Feld temp_code ist für Löschvorgänge erforderlich

Request​

Responses​

Liste der API-Schlüssel des Benutzers

Response Headers