API キーとスコープ
Guardrail Ledger のキーは、取り込みトークンの 1 種類だけです。スコープは設定できません。
| キー | 用途 | 管理できる人 |
|---|---|---|
| 取り込みトークン | パイプラインから /api/v1/ingest/sarif に SARIF を送信します。検出結果の読み取りや設定の変更はできません。 | ワークスペースのオーナーと管理者 |
トークンの取り扱い
- パイプラインページでトークンを発行します。トークンは一度だけ表示され、ハッシュのみが保持されます。
- シークレット変数として保存してください。リポジトリのファイルやスクリーンショットには載せないでください。
- パイプラインごとに 1 つのトークンを使ってください。ほかのトークンに影響せずに 1 つだけ失効できます。
- トークンを失効すると、そのトークンでの取り込みはすぐに停止します。失効は、オーナーまたは管理者としてサインインした状態で、JSON のコンテンツタイプと空の JSON 本文を指定して、API の
DELETE /api/v1/tokens/<id>で行います。
発行と失効はすべて、実行した人とともに監査ログに書き込まれます。