Atslēgas un webhooks
Akreditācijas dati un galapunkti, ko izsniegusi šī darbvieta.
Atslēgu un webhook rīki
| Rīks | Ko tas dara |
|---|---|
| listApiKeys | Katra API atslēga, ko izsniegusi šī darbvieta, ko tā drīkst darīt un kā vārdā tā drīkst sūtīt — maskētā formā, ar ko pietiek, lai atšķirtu divas atslēgas, un ne vairāk. |
| rotateApiKey | Piešķir atslēgai jaunu noslēpumu, saglabājot tās id, nosaukumu, tvērumus, lomu un sūtīšanas tvērumu. Pārklāšanās perioda nav, un jaunais noslēpums tiek parādīts vienu reizi. |
| setApiKeyEnabled | Izslēdz atslēgu vai ieslēdz to atpakaļ. Šī ir atgriezeniskā darbība: atslēga saglabā savu noslēpumu, tvērumus, lomu un sūtīšanas tvērumu. |
| revokeApiKey | Neatgriezeniski atsauc atslēgu. Atsauktu atslēgu nekad nevar ne ieslēgt atpakaļ, ne rotēt, ne mainīt. |
| setApiKeySendScope | Norāda, kuru adrešu vārdā atslēga drīkst sūtīt, kā divus neatkarīgus sarakstus. Tas, ko padodat, AIZSTĀJ to, kas atslēgai bija. |
| listWebhooks | Katrs šīs darbvietas webhook galapunkts, kurp tas sūta, vai tas ir ieslēgts un kurus notikumus tas ir pieprasījis. Parakstīšanas noslēpumi nekad netiek rādīti. |
| listWebhookEvents | Katrs notikums, kuram galapunkts var pieteikties, grupēts pa saimēm, ar rindiņu par to, kad katrs no tiem nostrādā. |
Noslēpums tiek parādīts vienreiz — kad atslēga tiek izveidota vai rotēta —, un pēc tam to vairs nekas neatgūst. rotateApiKey ir vienīgais rīks šeit, kas to atdod, tāpēc tam, kas glabā veco noslēpumu, jaunais jāpadod, pirms tas nākamreiz darbojas.
Ķerieties pie setApiKeyEnabled, pirms ķeraties pie revokeApiKey. Atslēgas izslēgšana ir atgriezeniska un parāda, vai kaut kas no tās vēl ir atkarīgs; atsaukšana ir neatgriezeniska, un vienīgais ceļš uz priekšu no tās ir jauna atslēga un jauns noslēpums.
Šeit nav ne createApiKey, ne createWebhook — tā paša iemesla dēļ, kāpēc nav createRole: akreditācijas datu izsniegšana no tērzēšanas loga ir klusa, plaša izmaiņa, ko pēc tam neviens neredz. Abi ir Iestatījumos, kur tas, kurš to dara, redz, ko viņš izsniedz.