API-Schlüssel
API-Schlüssel authentifizieren Anfragen an die ConsentForge-Verwaltungs-API. Sie unterscheiden sich von Embed-Tokens — halten Sie sie geheim und verwenden Sie sie nur von Ihrem Backend aus.
API-Schlüssel erstellen
Konto → API-Schlüssel → Schlüssel erstellen
- Geben Sie einen beschreibenden Namen ein (z. B. „Backend-Sync — Produktion")
- Wählen Sie die für Ihre Integration benötigten Berechtigungsbereiche (minimal notwendig)
- Legen Sie ein Ablaufdatum fest (optional, aber empfohlen)
- Klicken Sie auf Erstellen
Kopieren Sie den Schlüssel sofort — er wird nur einmal angezeigt.
Verfügbare Berechtigungsbereiche
| Bereich | Zugang |
|---|---|
properties:read | Properties auflisten und anzeigen |
properties:write | Properties erstellen und aktualisieren |
policies:read | Richtlinien und Versionen anzeigen |
policies:write | Richtlinien erstellen, veröffentlichen, zurücksetzen |
receipts:read | Einwilligungsbelege anzeigen |
receipts:export | Belege exportieren (große Ergebnismengen) |
webhooks:read | Webhook-Konfiguration anzeigen |
webhooks:write | Webhooks erstellen und aktualisieren |
users:read | Kontonutzer auflisten |
users:write | Nutzer einladen und entfernen |
scan:trigger | Scans via API auslösen |
admin | Vollständiger Zugang — sparsam verwenden |
Schlüsselablauf
Legen Sie ein Ablaufdatum fest, um den Schaden bei Kompromittierung eines Schlüssels zu begrenzen. Abgelaufene Schlüssel hören automatisch auf zu funktionieren.
Rotieren Sie Schlüssel regelmäßig. Zum Rotieren: neuen Schlüssel erstellen → Integration aktualisieren → alten Schlüssel löschen.
Schlüssel widerrufen
Konto → API-Schlüssel → [Schlüsselname] → Widerrufen
Der Widerruf ist sofort wirksam. Jede Integration, die den Schlüssel verwendet, erhält 401 Unauthorized-Antworten.
Best Practices für 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 engsten Berechtigungsbereich verwenden, der für Ihren Anwendungsfall funktioniert
- Ablaufdatum für Schlüssel in CI/CD-Pipelines festlegen