Autenticação e chaves
Chave de API, token JWT e permissões.
Criar uma chave
- Em Configurações → API, crie uma chave e escolha as permissões e os ambientes em que ela pode agir. Somente o proprietário do tenant acessa essa área.
- Copie o client_id (
vdgk_…, público) e o client_secret (vdgs_…, privado). O segredo é exibido uma única vez. - Guarde o segredo no cofre do sistema que vai chamar a API, nunca no código. Para trocá-lo sem parada, crie a chave nova, atualize o sistema e só então revogue a antiga.
A aba Documentação da mesma tela mostra os ids dos ambientes, workflows e pipelines e gera exemplos com eles.
Token
Envie o client_id e o client_secret para POST /v1/auth/token (OAuth 2.0 client credentials). A resposta traz um access_token JWT válido por 1 hora, que deve ir no cabeçalho Authorization: Bearer <token> das demais chamadas. Revogar a chave invalida os tokens já emitidos imediatamente.
Permissões
workflows:readepipelines:read: listar recursos e consultar execuções.workflows:runepipelines:run: disparar execuções.
A chave pode valer para todos os ambientes do tenant ou só para os escolhidos. Um ambiente fora da chave responde 404.