Keys und Webhooks
Die Zugangsdaten und Endpunkte, die dieser Workspace ausgegeben hat.
Keys- und Webhook-Tools
| Tool | Was es tut |
|---|---|
| listApiKeys | Jeder API-Key, den dieser Workspace ausgegeben hat, was er darf und als was er senden darf – in maskierter Form, die gerade reicht, um zwei Keys auseinanderzuhalten, und mehr nicht. |
| rotateApiKey | Einem Key ein neues Secret geben, unter Beibehaltung von id, Name, Scopes, Rolle und Sende-Scope. Es gibt kein Überlappungsfenster, und das neue Secret wird einmal angezeigt. |
| setApiKeyEnabled | Einen Key abschalten oder wieder einschalten. Das ist die umkehrbare Variante: Der Key behält sein Secret, seine Scopes, seine Rolle und seinen Sende-Scope. |
| revokeApiKey | Einen Key dauerhaft widerrufen. Ein widerrufener Key lässt sich nie wieder einschalten, rotieren oder ändern. |
| setApiKeySendScope | Angeben, als welche Adressen ein Key senden darf, in zwei unabhängigen Listen. Was Sie übergeben, ERSETZT, was der Key hatte. |
| listWebhooks | Jeder Webhook-Endpunkt dieses Workspace, wohin er postet, ob er aktiviert ist und welche Events er angefordert hat. Signing Secrets werden nie angezeigt. |
| listWebhookEvents | Jedes Event, das ein Endpunkt abonnieren kann, nach Familie gruppiert, mit einer Zeile dazu, wann es jeweils ausgelöst wird. |
Ein Secret wird einmal angezeigt, beim Anlegen oder Rotieren des Keys, und nichts stellt es danach wieder her. rotateApiKey ist das einzige Tool hier, das eines zurückgibt; was auch immer das alte Secret hält, muss den Ersatz bekommen, bevor es das nächste Mal läuft.
Greifen Sie zu setApiKeyEnabled, bevor Sie zu revokeApiKey greifen. Einen Key abzuschalten ist umkehrbar und zeigt Ihnen, ob noch etwas von ihm abhängt; ein Widerruf ist endgültig, und der einzige Weg weiter führt über einen neuen Key und ein neues Secret.
Es gibt hier kein createApiKey und kein createWebhook, aus demselben Grund, aus dem es kein createRole gibt: Zugangsdaten aus einem Chatfenster heraus auszugeben ist eine leise, weitreichende Änderung, die hinterher niemand sieht. Beides steckt in Settings, wo die handelnde Person sieht, was sie da aus der Hand gibt.