Ключи и вебхуки
Учётные данные и эндпоинты, выданные этим рабочим пространством.
Инструменты ключей и вебхуков
| Инструмент | Что делает |
|---|---|
| listApiKeys | Все ключи API, выданные этим рабочим пространством, что каждому из них позволено и от каких адресов он может отправлять, в замаскированном виде, которого хватает, чтобы отличить два ключа друг от друга, и не более. |
| rotateApiKey | Выдать ключу новый секрет, сохранив его id, имя, скоупы, роль и область отправки. Окна перекрытия нет, и новый секрет показывается один раз. |
| setApiKeyEnabled | Выключить ключ или включить обратно. Это обратимое действие: ключ сохраняет свой секрет, свои скоупы, свою роль и свою область отправки. |
| revokeApiKey | Отозвать ключ навсегда. Отозванный ключ уже никогда нельзя включить обратно, ротировать или изменить. |
| setApiKeySendScope | Указать, от каких адресов ключ может отправлять, двумя независимыми списками. Переданное ЗАМЕНЯЕТ то, что было у ключа. |
| listWebhooks | Все эндпоинты вебхуков этого рабочего пространства: куда каждый шлёт, включён ли он и какие события запросил. Секреты подписи не показываются никогда. |
| listWebhookEvents | Все события, на которые может подписаться эндпоинт, сгруппированные по семействам, со строкой о том, когда каждое из них срабатывает. |
Секрет показывается один раз — при создании или ротации ключа, — и после этого его ничем не восстановить. rotateApiKey — единственный инструмент здесь, который его возвращает, поэтому тому, что держит старый секрет, нужно передать замену до его следующего запуска.
Тянитесь к setApiKeyEnabled раньше, чем к revokeApiKey. Выключение ключа обратимо и показывает, зависит ли от него ещё что-нибудь; отзыв необратим, и единственный путь дальше от него — новый ключ и новый секрет.
Здесь нет ни createApiKey, ни createWebhook — по той же причине, по которой нет createRole: выдача учётных данных из окна чата — тихое, широкое изменение, которого потом никто не видит. Оба есть в Настройках, где тот, кто это делает, видит, что именно он раздаёт.