کلیدها و وبهوکها
اعتبارنامهها و اندپوینتهایی که این فضای کاری صادر کرده است.
ابزارهای کلیدها و وبهوکها
| ابزار | چه میکند |
|---|---|
| listApiKeys | هر کلید API که این فضای کاری صادر کرده، اینکه چه کاری مجاز است بکند و با چه نشانیهایی مجاز است بفرستد، به شکلی پوشیده که فقط برای تشخیص دو کلید از هم بس است و نه بیشتر. |
| rotateApiKey | به یک کلید راز تازهای بدهید و id، نام، اسکوپها، نقش و دامنهٔ ارسالش را نگه دارید. هیچ بازهٔ همپوشانیای وجود ندارد و راز تازه یکبار نشان داده میشود. |
| setApiKeyEnabled | یک کلید را خاموش کنید، یا دوباره روشن. این همان کنش برگشتپذیر است: کلید راز، اسکوپها، نقش و دامنهٔ ارسالش را نگه میدارد. |
| revokeApiKey | یک کلید را برای همیشه باطل کنید. کلید باطلشده هرگز دوباره روشن، چرخانده یا تغییر داده نمیشود. |
| setApiKeySendScope | بگویید یک کلید با چه نشانیهایی مجاز است بفرستد، در قالب دو فهرست مستقل. آنچه میفرستید جایگزین آنچه کلید داشته میشود. |
| listWebhooks | هر اندپوینت وبهوک این فضای کاری، اینکه کجا ارسال میکند، فعال هست یا نه، و کدام رویدادها را خواسته است. رازهای امضا هرگز نشان داده نمیشوند. |
| listWebhookEvents | هر رویدادی که یک اندپوینت میتواند مشترکش شود، گروهبندیشده بر پایهٔ خانواده، با یک خط توضیح دربارهٔ اینکه هرکدام کِی شلیک میشود. |
راز یکبار نشان داده میشود، هنگام ساختن یا چرخاندن کلید، و پس از آن هیچ چیزی بازش نمیگرداند. rotateApiKey تنها ابزاری اینجاست که رازی برمیگرداند، پس هرچه راز قدیمی را در دست دارد باید پیش از اجرای بعدیاش جایگزین را بگیرد.
پیش از revokeApiKey سراغ setApiKeyEnabled بروید. خاموش کردن یک کلید برگشتپذیر است و به شما میگوید آیا هنوز چیزی به آن وابسته است یا نه؛ باطل کردن همیشگی است و تنها راه پیشِ رو از آن، کلیدی تازه و رازی تازه است.
اینجا نه createApiKey هست و نه createWebhook، به همان دلیلی که createRole نیست: صادر کردن یک اعتبارنامه از درون پنجرهٔ گفتوگو تغییری خاموش و گسترده است که کسی بعداً آن را نمیبیند. هر دو در Settings هستند، جایی که هرکس این کار را میکند میبیند چه چیزی را واگذار میکند.