Claus i webhooks
Les credencials i els endpoints que ha emès aquest espai de treball.
Eines de claus i webhooks
| Eina | Què fa |
|---|---|
| listApiKeys | Totes les claus API que ha emès aquest espai de treball, què poden fer i com poden enviar, en una forma emmascarada que n'hi ha prou per distingir dues claus i res més. |
| rotateApiKey | Dona un secret nou a una clau, mantenint-ne l'id, el nom, els scopes, el rol i l'abast d'enviament. No hi ha cap finestra de solapament, i el secret nou es mostra una sola vegada. |
| setApiKeyEnabled | Desactiva una clau, o torna-la a activar. Aquesta és la reversible: la clau conserva el seu secret, els seus scopes, el seu rol i el seu abast d'enviament. |
| revokeApiKey | Revoca una clau permanentment. Una clau revocada no es pot tornar a activar, ni rotar, ni canviar mai més. |
| setApiKeySendScope | Indica amb quines adreces pot enviar una clau, en dues llistes independents. El que passis SUBSTITUEIX el que tenia la clau. |
| listWebhooks | Tots els endpoints de webhook que té aquest espai de treball, on publiquen, si estan activats i quins esdeveniments han demanat. Els secrets de signatura no es mostren mai. |
| listWebhookEvents | Tots els esdeveniments a què es pot subscriure un endpoint, agrupats per família, amb una línia que diu quan es dispara cadascun. |
Un secret es mostra una sola vegada, quan es crea o es rota la clau, i després res no el recupera. rotateApiKey és l'única eina d'aquí que en retorna un, de manera que allò que tingui el secret antic ha de rebre el substitut abans de la propera execució.
Fes servir setApiKeyEnabled abans que revokeApiKey. Desactivar una clau és reversible i et diu si encara hi ha res que en depèn; revocar-la és permanent i l'única sortida endavant és una clau nova i un secret nou.
Aquí no hi ha cap createApiKey ni cap createWebhook, pel mateix motiu que no hi ha createRole: emetre una credencial des d'una finestra de xat és un canvi silenciós i ampli que després ningú no veu. Tots dos són a Configuració, on qui ho fa pot veure què està repartint.