Документация

Профиль и персональные API-токены

Версия v2.3.1 · Обновлено

Профиль и персональные API-токены#

Откройте:

Profile

Страница профиля содержит идентификационные данные пользователя, контактные поля, контекст активной группы и персональные API-токены.

Контактные поля#

Заполните контактные поля, используемые каналами уведомлений.

ПолеИспользуется
EmailКаналом Email
PhoneКаналом голосовых вызовов
Mattermost user IDДля атрибуции действий в Mattermost
Telegram user IDДля действий в Telegram
Slack user IDДля атрибуции действий ACK/Resolve/Shelve в Slack; также используется при административной синхронизации Slack usergroup

Каналы Email и голосовых вызовов отправляют на контактные данные из профиля назначенного пользователя, а не на списки получателей на уровне канала.

Браузерные push-уведомления#

Браузерные push-уведомления настраиваются для каждого пользователя в профиле.

Используйте:

Enable push on this device
Send test push
Disable

Браузерные push-уведомления не являются каналом уведомлений. Когда алерт назначается пользователю, IncidentRelay может отправлять push-уведомления на активные устройства (браузер/PWA) пользователя. Кнопки ACK, Resolve, Shelve и Unshelve используют короткоживущие одноразовые токены действий.

Подробнее: Браузерные push-уведомления.

Активная группа#

Активная группа управляет текущим контекстом группы в интерфейсе и для операций в рамках группы.

Обычный пользователь видит группы, где у него есть активное членство. Глобальный администратор может получить доступ ко всем активным группам в соответствии с поведением глобального администратора.

Персональные API-токены#

Персональные токены обеспечивают доступ к API от имени текущего пользователя.

Рекомендуемые практики:

  • используйте короткоживущие токены, где это возможно;
  • ограничивайте использование токена нужной группой, когда интерфейс/API это поддерживает;
  • ротируйте токены после компрометации;
  • удаляйте неиспользуемые токены.

Области доступа токенов#

Токен может содержать любое сочетание детализированных областей доступа. Используйте области :read для отчётов и интеграций только для чтения, а соответствующую область :write добавляйте, только если интеграция должна изменять этот ресурс.

РесурсЧтениеЗапись
Алертыalerts:readalerts:write
Инцидентыincidents:readincidents:write
Сервисы, включая бизнес-сервисыservices:readservices:write
Командыteams:readteams:write
Группыgroups:readgroups:write
Пользователиusers:readusers:write
Ротации и состояние дежурствrotations:readrotations:write
Календарьcalendar:readcalendar:write
Маршрутыroutes:readroutes:write
Каналыchannels:readchannels:write
Окна обслуживания и заглушкиmaintenance:readmaintenance:write
Heartbeatsheartbeats:readheartbeats:write
Политики эскалации, уведомлений, приоритетов и matcherspolicies:readpolicies:write
Оркестрации событийorchestrations:readorchestrations:write
Журнал аудитаaudit:read—
Администрирование SSOsso:readsso:write
Текущий профиль и личные настройки уведомленийprofile:readprofile:write

Например, токен для отчётности только для чтения, объединяющей алерты с метаданными сервисов, инцидентов и команд, может использовать:

alerts:read
services:read
incidents:read
teams:read

resources:read и resources:write — устаревшие агрегированные области доступа. Они продолжают поддерживаться для существующих клиентов и включают соответствующие детализированные области ресурсов, но в новых интеграциях следует предпочитать детализированные области.

* предоставляет все настроенные области доступа и доступен только глобальным администраторам. Области записи не включают области чтения автоматически; если клиенту нужны обе операции, выберите обе области.

Проверка областей доступа API-токенов закрывает доступ по умолчанию. Защищённый эндпоинт /api/... должен быть сопоставлен области доступа, прежде чем API-токен сможет к нему обратиться. Это не позволяет новым API-эндпоинтам незаметно становиться доступными существующим токенам.