API токены¶

В Консоли управления Вебмониторэкс → Настройки → Токены API вы можете управлять токенами для аутентификации запросов API.

Данный раздел доступен для всех ролей, кроме Только чтение, Разработчик API, Глобальный аналитик, Аналитик.

Настройка токенов¶

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

Для каждого своего токена вы можете установить права доступа, но не шире тех, которые есть у вашего пользователя.
У каждого API-токена есть обязательный срок действия. Задать срок действия можно при создании ключа.
- Стандартный срок действия: 180 календарных дней – в случае, если не выбрана дата окончания срока действия токена.
- Максимальный срок действия: 365 календарных дней.
Перед автоматическим удалением API-токена система направит уведомления (Email, уведомления в Консоли управления):
- за 30 дней
- за 7 дней
- за 1 день
Уведомления получат пользователи с ролью Администратор (по всем токенам в рамках клиентам) и владелец токена.

Администраторы/Глобальные администраторы могут просматривать и управлять всеми токенами в учетной записи компании. Помимо частных токенов, они могут создавать общие токены, которые могут просматривать/использовать другие администраторы.

Конфиденциальность токена

Никакие другие пользователи (даже администраторы) не могут использовать ваши личные токены (просматривать или копировать токены). Кроме того, пользователи, не являющиеся администраторами, даже не увидят ваши токены.

Обратите внимание:

Если владелец токена отключен, все его токены также автоматически отключаются.
Если у владельца токена были уменьшены права, то соответствующие права будут удалены со всех его токенов.
Все отключенные токены автоматически удаляются через неделю после отключения.
Чтобы включить ранее отключенный токен, сохраните его с новым сроком действия.

Токены с обратной совместимостью¶

Раньше для аутентификации запроса использовались UUID и секретный ключ, которые теперь заменены токенами. UUID и секретный ключ, которые вы использовали, автоматически преобразуются в обратно совместимый токен. С этим токеном запросы, аутентифицированные с помощью UUID и секретного ключа, будут продолжать работать.

Копирование токена из Консоли управления Вебмониторэкс

Если вы обновите значение обратно совместимого токена или включите SSO/строгий SSO для владельца этого токена, обратная совместимость прекратится – все запросы, аутентифицированные со старым UUID и секретным ключом, перестанут работать.

Вы также можете использовать сгенерированное значение обратно совместимого токена, передав его в параметре заголовка X-WallarmApi-Token ваших запросов.

Токен обратной совместимости имеет те же права, что и роль пользователя, эти права не отображаются в окне токена и не могут быть изменены. Если вы хотите контролировать права, вам необходимо удалить обратно совместимый токен и создать новый.

Токены API и токены ноды¶

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

Одним из клиентов, обращающихся к Вычислительному кластеру Вебмониторэкс API, является сама нода фильтрации Вебмониторэкс. Для доступа фильтрующей ноды к Вычислительному кластеру Вебмониторэкс необходимо использовать API-токен с ролью «Деплой» либо токен Ноды. Подробнее о токенах →