Keys en webhooks
De credentials en endpoints die deze workspace heeft uitgegeven.
Tools voor keys en webhooks
| Tool | Wat het doet |
|---|---|
| listApiKeys | Elke API-key die deze workspace heeft uitgegeven, wat hij mag doen en als wie hij mag verzenden, in een gemaskeerde vorm die genoeg is om twee keys uit elkaar te houden en niets meer. |
| rotateApiKey | Geef een key een nieuw secret, met behoud van zijn id, naam, scopes, rol en send scope. Er is geen overlapvenster, en het nieuwe secret wordt één keer getoond. |
| setApiKeyEnabled | Zet een key uit, of weer aan. Dit is de omkeerbare: de key behoudt zijn secret, zijn scopes, zijn rol en zijn send scope. |
| revokeApiKey | Trek een key permanent in. Een ingetrokken key kan nooit meer worden aangezet, geroteerd of gewijzigd. |
| setApiKeySendScope | Geef aan als welke adressen een key mag verzenden, als twee onafhankelijke lijsten. Wat je meegeeft VERVANGT wat de key had. |
| listWebhooks | Elk webhook-endpoint dat deze workspace heeft, waar het naartoe post, of het is ingeschakeld en welke events het heeft aangevraagd. Signing secrets worden nooit getoond. |
| listWebhookEvents | Elk event waarop een endpoint zich kan abonneren, gegroepeerd per familie, met een regel die zegt wanneer elk event afgaat. |
Een secret wordt één keer getoond, wanneer de key wordt gemaakt of geroteerd, en niets haalt het daarna terug. rotateApiKey is de enige tool hier die er een teruggeeft, dus wat het oude secret bewaart moet de vervanger krijgen voordat het de volgende keer draait.
Grijp naar setApiKeyEnabled voordat je naar revokeApiKey grijpt. Een key uitzetten is omkeerbaar en vertelt je of er nog iets van afhangt; intrekken is permanent en de enige weg vooruit is een nieuwe key met een nieuw secret.
Er is hier geen createApiKey en geen createWebhook, om dezelfde reden dat er geen createRole is: een credential uitgeven vanuit een chatvenster is een stille, brede wijziging die niemand achteraf ziet. Beide staan in Settings, waar degene die het doet kan zien wat hij weggeeft.