API-Schlüssel
API-Schlüssel authentifizieren Anfragen an die ConsentForge-Verwaltungs-API. Sie unterscheiden sich von Einbettungstoken – halten Sie sie geheim und verwenden Sie sie nur in Ihrem Backend.
API-Schlüssel erstellen
Konto → API-Schlüssel → Schlüssel erstellen
- Einen beschreibenden Namen eingeben (z. B. „Backend-Sync – Produktion")
- Die Scopes auswählen, die Ihre Integration benötigt (so wenig wie möglich)
- Ein Ablaufdatum festlegen (optional, aber empfohlen)
- Auf Erstellen klicken
Kopieren Sie den Schlüssel sofort – er wird nur einmal angezeigt.
Verfügbare Scopes
| Scope | Zugriff |
|---|---|
properties:read | Eigenschaften auflisten und anzeigen |
properties:write | Eigenschaften erstellen und aktualisieren |
policies:read | Richtlinien und Versionen anzeigen |
policies:write | Richtlinien erstellen, veröffentlichen, zurücksetzen |
receipts:read | Einwilligungsquittungen anzeigen |
receipts:export | Quittungen exportieren (große Ergebnismengen) |
webhooks:read | Webhook-Konfiguration anzeigen |
webhooks:write | Webhooks erstellen und aktualisieren |
users:read | Kontobenutzer auflisten |
users:write | Benutzer einladen und entfernen |
scan:trigger | Scans über die API auslösen |
admin | Vollzugriff – sparsam verwenden |
Schlüsselablauf
Legen Sie ein Ablaufdatum fest, um den Schaden bei einem kompromittierten Schlüssel zu begrenzen. Abgelaufene Schlüssel hören automatisch auf zu funktionieren.
Rotieren Sie Schlüssel regelmäßig. So rotieren Sie: neuen Schlüssel erstellen → Integration aktualisieren → alten Schlüssel löschen.
Schlüssel widerrufen
Konto → API-Schlüssel → [Schlüsselname] → Widerrufen
Der Widerruf erfolgt sofort. Jede Integration, die den Schlüssel verwendet, erhält danach 401 Unauthorized-Antworten.
Best Practices für die Schlüsselsicherheit
- Schlüssel in Umgebungsvariablen oder einem Secrets-Manager speichern, niemals im Quellcode
- Einen Schlüssel pro Integration verwenden (einfacher, einen einzelnen kompromittierten Schlüssel zu widerrufen)
- Den kleinstmöglichen Scope verwenden, der für den Anwendungsfall ausreicht
- Ein Ablaufdatum für Schlüssel in CI/CD-Pipelines festlegen