Klucze i webhooki
Poświadczenia i endpointy wydane przez tę przestrzeń roboczą.
Narzędzia kluczy i webhooków
| Narzędzie | Co robi |
|---|---|
| listApiKeys | Każdy klucz API wydany przez tę przestrzeń roboczą, co mu wolno i jako kto może wysyłać, w postaci zamaskowanej — wystarczającej, by odróżnić dwa klucze, i nic ponad to. |
| rotateApiKey | Nadaj kluczowi nowy sekret, zachowując jego id, nazwę, zakresy, rolę i zakres wysyłki. Nie ma okresu nakładania się, a nowy sekret pokazywany jest raz. |
| setApiKeyEnabled | Wyłącz klucz albo włącz go z powrotem. To ta odwracalna operacja: klucz zachowuje swój sekret, swoje zakresy, swoją rolę i swój zakres wysyłki. |
| revokeApiKey | Unieważnij klucz na stałe. Unieważnionego klucza nie da się już włączyć, zrotować ani zmienić. |
| setApiKeySendScope | Określ, jako które adresy klucz może wysyłać, w postaci dwóch niezależnych list. To, co przekażesz, ZASTĘPUJE to, co klucz miał. |
| listWebhooks | Każdy endpoint webhooka w tej przestrzeni roboczej, dokąd wysyła, czy jest włączony i o które zdarzenia poprosił. Sekrety podpisujące nigdy nie są pokazywane. |
| listWebhookEvents | Każde zdarzenie, na które endpoint może się zapisać, pogrupowane rodzinami, z wierszem mówiącym, kiedy każde z nich się uruchamia. |
Sekret pokazywany jest raz, przy utworzeniu albo rotacji klucza, i potem nic go nie odzyska. rotateApiKey to jedyne narzędzie tutaj, które go zwraca, więc cokolwiek trzyma stary sekret, musi dostać zamiennik, zanim uruchomi się następnym razem.
Sięgaj po setApiKeyEnabled przed revokeApiKey. Wyłączenie klucza jest odwracalne i pokazuje, czy coś jeszcze od niego zależy; unieważnienie jest trwałe, a jedyną drogą dalej jest nowy klucz i nowy sekret.
Nie ma tu createApiKey ani createWebhook z tego samego powodu, dla którego nie ma createRole: wydanie poświadczenia z okna czatu to cicha, szeroka zmiana, której potem nikt nie widzi. Oba są w Settings, gdzie ten, kto to robi, widzi, co rozdaje.