Zum Hauptinhalt springen

Verify User API Key (Service-to-Service)

POST 
/apikeys/verify

Öffentlicher Endpunkt für andere Dienste zur Überprüfung von Benutzer-API-Schlüsseln. Typischer Ablauf: 1. Ein externer Dienst erhält einen Benutzer-API-Schlüssel 2. Sendet eine Anfrage an diesen Endpunkt zur Überprüfung 3. Verwendet seinen eigenen System-API-Schlüssel im X-API-Key-Header 4. Erhält Informationen über den Benutzer, dem der API-Schlüssel gehört Anwendungsfälle: - Microservices überprüfen Benutzer-API-Schlüssel - Externe Dienste validieren die Authentifizierung - Das API-Gateway überprüft Benutzerberechtigungen Erforderliche Authentifizierung: - X-API-Key Header mit dem API-Schlüssel des anfragenden Dienstes - Erfordert keinen Benutzer-JWT-Token Zurückgegebene Informationen: - Daten des Benutzers, dem der API-Schlüssel gehört - Benutzerberechtigungen und Rolle - Kontostatus und zugehöriges Unternehmen Wichtige Hinweise: - Nur autorisierte Dienste können diesen Endpunkt verwenden - Der überprüfte API-Schlüssel muss aktiv sein - Enthält Informationen über das Unternehmen des Benutzers - Die Nutzung wird zur Überwachung protokolliert

Request​

Responses​

Benutzer-API-Schlüssel erfolgreich überprüft