Clés et webhooks
Les identifiants et les points de terminaison que cet espace de travail a délivrés.
Outils Clés et webhooks
| Outil | Ce qu'il fait |
|---|---|
| listApiKeys | Toutes les clés API délivrées par cet espace de travail, ce qu'elles ont le droit de faire et les adresses au nom desquelles elles peuvent envoyer, sous une forme masquée qui suffit à distinguer deux clés et rien de plus. |
| rotateApiKey | Donner un nouveau secret à une clé, en conservant son id, son nom, ses scopes, son rôle et son périmètre d'envoi. Il n'y a pas de période de recouvrement, et le nouveau secret n'est affiché qu'une fois. |
| setApiKeyEnabled | Désactiver une clé, ou la réactiver. C'est l'opération réversible : la clé conserve son secret, ses scopes, son rôle et son périmètre d'envoi. |
| revokeApiKey | Révoquer définitivement une clé. Une clé révoquée ne peut plus jamais être réactivée, ni voir son secret renouvelé, ni être modifiée. |
| setApiKeySendScope | Indiquer les adresses au nom desquelles une clé peut envoyer, sous la forme de deux listes indépendantes. Ce que vous transmettez REMPLACE ce que la clé avait. |
| listWebhooks | Tous les points de terminaison de webhook de cet espace de travail : où ils postent, s'ils sont activés et quels événements ils ont demandés. Les secrets de signature ne sont jamais affichés. |
| listWebhookEvents | Tous les événements auxquels un point de terminaison peut s'abonner, regroupés par famille, avec une ligne indiquant quand chacun se déclenche. |
Un secret n'est affiché qu'une fois, à la création ou au renouvellement de la clé, et rien ne permet de le récupérer ensuite. rotateApiKey est le seul outil ici qui en renvoie un : ce qui détient l'ancien secret doit donc recevoir le remplaçant avant sa prochaine exécution.
Préférez setApiKeyEnabled à revokeApiKey. Désactiver une clé est réversible et vous dit si quelque chose en dépend encore ; la révocation est définitive et la seule issue est alors une nouvelle clé et un nouveau secret.
Il n'y a ici ni createApiKey ni createWebhook, pour la même raison qu'il n'y a pas de createRole : délivrer un identifiant depuis une fenêtre de conversation est un changement discret et large que personne ne voit ensuite. Les deux se trouvent dans Paramètres, où la personne qui agit voit ce qu'elle distribue.