Kulcsok és webhookok
A munkaterület által kiadott hitelesítő adatok és végpontok.
Kulcs- és webhookeszközök
| Eszköz | Mit csinál |
|---|---|
| listApiKeys | A munkaterület által kiadott összes API-kulcs, hogy mit tehetnek és milyen címről küldhetnek, maszkolt formában, amely épp elég két kulcs megkülönböztetéséhez és semmi többhöz. |
| rotateApiKey | Új titkot ad egy kulcsnak, megtartva az id, a név, a hatókörök, a szerepkör és a küldési hatókör értékét. Nincs átfedési időszak, és az új titkot egyszer mutatjuk meg. |
| setApiKeyEnabled | Kulcs kikapcsolása vagy visszakapcsolása. Ez a visszafordítható művelet: a kulcs megtartja a titkát, a hatóköreit, a szerepkörét és a küldési hatókörét. |
| revokeApiKey | Kulcs végleges visszavonása. A visszavont kulcsot soha nem lehet visszakapcsolni, rotálni vagy módosítani. |
| setApiKeySendScope | Megadja, mely címekről küldhet egy kulcs, két független listaként. Amit átad, LECSERÉLI azt, ami a kulcsnál volt. |
| listWebhooks | A munkaterület összes webhook-végpontja, hogy hová küld, engedélyezve van-e, és mely eseményeket kérte. Az aláíró titkokat soha nem mutatjuk meg. |
| listWebhookEvents | Minden esemény, amelyre egy végpont feliratkozhat, családok szerint csoportosítva, egy-egy sorral arról, mikor lép működésbe. |
A titkot egyszer mutatjuk meg, a kulcs létrehozásakor vagy rotálásakor, és utána semmi nem állítja vissza. A rotateApiKey az egyetlen eszköz itt, amely visszaad ilyet, ezért ami a régi titkot tartja, annak át kell adni a cserét, mielőtt legközelebb lefutna.
Előbb a setApiKeyEnabled eszközért nyúljon, ne a revokeApiKey eszközért. Egy kulcs kikapcsolása visszafordítható, és megmutatja, függ-e még tőle bármi; a visszavonás végleges, és onnan csak új kulcson és új titkon át vezet út.
Itt nincs createApiKey és nincs createWebhook, ugyanazért, amiért nincs createRole: hitelesítő adat kiadása egy csevegőablakból csendes, széles hatókörű változtatás, amelyet utána senki nem lát. Mindkettő a Beállítások alatt van, ahol az, aki csinálja, látja, mit ad ki a kezéből.