Chaves de API e âmbitos

Uma chave de API dá a um script ou serviço acesso ao seu espaço de trabalho sem que uma pessoa inicie sessão. As chaves têm âmbitos, pelo que uma chave pode ser limitada ao que a sua função exige.

Criar uma chave

Inicie sessão como administrador e abra API Keys.
Dê um nome à chave, escolha os seus âmbitos e, se quiser, uma validade em dias.
Copie a chave quando for mostrada. Começa por xcrt_ e não pode voltar a ser mostrada.

Apenas um administrador com sessão iniciada pode criar ou revogar uma chave, e uma chave só pode receber âmbitos que o seu criador possua. Uma chave nova recebe certs:read, salvo se escolher outros.

Utilizar uma chave

curl -H "Authorization: Bearer xcrt_your_key" \
     https://api.automate-certificates.com/v1/certificates

Âmbitos

Âmbito	Permite
`certs:read`	Listar e ler certificados e os respetivos desafios.
`certs:write`	Pedir, renovar, importar, revogar e eliminar certificados.
`targets:read`	Listar e ler alvos.
`targets:write`	Criar, alterar e eliminar alvos.
`deploy:read`	Ler implementações.
`deploy:execute`	Executar implementações e gerir regras de implementação.
`monitoring:read`	Ler resultados de monitorização.
`alerts:read`	Ler alertas.
`alerts:write`	Definir regras de alerta e gerir webhooks.
`audit:read`	Ler o registo de auditoria.

O que uma chave com âmbito não pode fazer

Gerir membros, funções, chaves de API, contas ACME e credenciais cloud exige um administrador com sessão iniciada ou uma chave de acesso total. Uma chave com âmbito é recusada com 403 insufficient_scope, mesmo quando o seu proprietário é administrador. Algumas ações de administrador, como executar uma análise de descoberta ou uma renovação em massa, aceitam uma chave que tenha o âmbito correspondente e pertença a um administrador.

Limites

Cada plano permite um número fixo de chaves. Os pedidos estão limitados a 120 por minuto por espaço de trabalho.