Documentação do Guardrail Ledger
Chaves de API e âmbitos
O Guardrail Ledger tem um só tipo de chave, o token de ingestão. Não tem âmbitos configuráveis.
| Chave | Usada para | Quem a pode gerir |
|---|---|---|
| Token de ingestão | Enviar SARIF para /api/v1/ingest/sarif a partir de um pipeline. Não pode ler descobertas nem alterar definições. | Proprietários e administradores do espaço de trabalho |
Gerir tokens
- Crie um token na página Pipeline. É mostrado uma só vez e apenas o seu hash é guardado.
- Guarde-o como variável secreta. Nunca o coloque num ficheiro do repositório nem numa captura de ecrã.
- Use um token por pipeline, para poder revogar um sem tocar nos outros.
- Revogar um token pára de imediato a ingestão com ele. Revogue através da API com
DELETE /api/v1/tokens/<id>, com sessão iniciada como proprietário ou administrador, com um tipo de conteúdo JSON e um corpo JSON vazio.
Cada criação e revogação é escrita no registo de auditoria com quem a fez.