Chaves e webhooks
As credenciais e os endpoints que este espaço de trabalho emitiu.
Ferramentas de chaves e webhooks
| Ferramenta | O que faz |
|---|---|
| listApiKeys | Todas as chaves de API que este espaço de trabalho emitiu, o que cada uma pode fazer e em nome de que endereços pode enviar, numa forma mascarada que chega para distinguir duas chaves e mais nada. |
| rotateApiKey | Dá um novo segredo a uma chave, mantendo o id, o nome, os âmbitos, a função e o âmbito de envio. Não há janela de sobreposição, e o novo segredo é mostrado uma única vez. |
| setApiKeyEnabled | Desliga uma chave, ou volta a ligá-la. Esta é a reversível: a chave mantém o segredo, os âmbitos, a função e o âmbito de envio. |
| revokeApiKey | Revoga uma chave definitivamente. Uma chave revogada nunca mais pode ser reativada, rodada ou alterada. |
| setApiKeySendScope | Indica em nome de que endereços uma chave pode enviar, em duas listas independentes. O que passar SUBSTITUI o que a chave tinha. |
| listWebhooks | Todos os endpoints de webhook que este espaço de trabalho tem, para onde publicam, se estão ativos e que eventos pediram. Os segredos de assinatura nunca são mostrados. |
| listWebhookEvents | Todos os eventos que um endpoint pode subscrever, agrupados por família, com uma linha a dizer quando cada um dispara. |
Um segredo é mostrado uma única vez, quando a chave é criada ou rodada, e nada o recupera depois. O rotateApiKey é a única ferramenta aqui que devolve um, pelo que o que quer que detenha o segredo antigo tem de receber o substituto antes de voltar a correr.
Recorra ao setApiKeyEnabled antes do revokeApiKey. Desligar uma chave é reversível e diz-lhe se ainda há algo a depender dela; revogar é definitivo e a única saída a partir daí é uma chave nova e um segredo novo.
Não existe aqui createApiKey nem createWebhook, pela mesma razão por que não existe createRole: emitir uma credencial a partir de uma janela de conversa é uma alteração silenciosa e ampla que ninguém vê depois. Ambos estão em Definições, onde quem o faz consegue ver o que está a distribuir.