Guardrail-Ledger-Dokumentation
API-Schlüssel und Bereiche
Guardrail Ledger hat eine einzige Schlüsselart, das Ingest-Token. Es hat keine konfigurierbaren Bereiche.
| Schlüssel | Verwendet für | Wer es verwalten kann |
|---|---|---|
| Ingest-Token | SARIF aus einer Pipeline an /api/v1/ingest/sarif senden. Es kann weder Befunde lesen noch Einstellungen ändern. | Workspace-Owner und -Admins |
Umgang mit Tokens
- Erzeugen Sie ein Token auf der Seite Pipeline. Es wird einmal angezeigt, und nur sein Hash wird gespeichert.
- Speichern Sie es als geheime Variable. Legen Sie es niemals in einer Repository-Datei oder einem Screenshot ab.
- Verwenden Sie ein Token pro Pipeline, damit Sie eines widerrufen können, ohne die anderen anzufassen.
- Das Widerrufen eines Tokens beendet den Ingest damit sofort. Widerrufen Sie über die API mit
DELETE /api/v1/tokens/<id>, angemeldet als Owner oder Admin, mit einem JSON-Content-Type und einem leeren JSON-Body.
Jedes Erzeugen und Widerrufen wird mit der ausführenden Person im Audit-Log festgehalten.