API-токены
Данный раздел описывает процесс работы с API-токенами в системе R-Vision SIEM.
Об API-токенах
API R-Vision SIEM обеспечивает программный доступ к функционалу системы через протокол HTTP. Доступные операции API включают выполнение запросов и мутаций с использованием GraphQL, что позволяет управлять данными и настройками системы.
Взаимодействие с API осуществляется через HTTP-запросы методами POST для отправки GraphQL-запросов и мутаций. Каждый запрос требует наличия авторизационного токена в заголовке запроса. API-токен выпускается системой посредством функционала ботов. Бот — учетная запись, предназначенная для автоматизированного взаимодействия с системой через API-запросы. При создании бота, ему автоматически присваивается API-токен.
Работа с API-токенами
Доступные операции над API-токенами:
Создание API-токена
Чтобы выпустить API-токен, необходимо создать учетную запись типа Бот. При создании бота, ему автоматически присваивается API-токен, который можно использовать для создания запросов к системе.
Чтобы создать бота:
-
Перейдите в раздел Настройки → Пользователи. Система отобразит сведения о доступных пользователях.
-
Нажмите на кнопку Добавить (
) и выберите из выпадающего списка тип Бот. Система отобразит окно добавления бота. -
Заполните следующие поля:
-
Логин — задайте уникальный логин для учетной записи пользователя в системе.
-
Группа пользователей (опционально) — выберите из выпадающего списка группы, в которые должен входить пользователь.
-
Описание (опционально) — добавьте краткое описание учетной записи пользователя.
-
-
Назначьте роли пользователю, чтобы определить перечень его разрешений в системе.
Чтобы добавить роль:
-
Нажмите на кнопку Добавить роль (
). Появится строка настройки роли. -
Выберите из выпадающего списка роль, которую необходимо назначить пользователю.
-
При необходимости выберите из выпадающего списка тенанты, в рамках которых должна действовать роль.
Если тенанты не выбраны, роль действует во всех тенантах.
Чтобы удалить добавленную роль, нажмите на кнопку
в строке настройки роли.Если активирован переключатель Суперадминистратор, учетной записи предоставляются все доступные в системе разрешения. -
-
Нажмите на кнопку Добавить. Система создаст бота и отобразит соответствующее уведомление. Новый бот появится в списке раздела.
Копирование API-токена
Чтобы скопировать API-токен:
-
Перейдите в раздел Настройки → Пользователи. Система отобразит список доступных пользователей.
-
Нажмите на строку нужного бота в списке. Система отобразит в правой части экрана карточку этого пользователя с подробной информацией о нем.
-
Нажмите на кнопку Скопировать токен в нижней части карточки. Система скопирует выбранный токен в буфер обмена и отобразит соответствующее уведомление.
Перевыпуск API-токена
Чтобы сбросить период хранения токена, необходимо перевыпустить токен для бота, к которому относится нужный токен. Предыдущий токен будет удален и станет недоступным для использования. Срок жизни токена будет отсчитываться от даты перевыпуска API-токена.
Чтобы обновить API-токен:
-
Перейдите в раздел Настройки → Пользователи. Система отобразит список доступных пользователей.
-
Нажмите на строку нужного бота в списке. Система отобразит в правой части экрана карточку этого бота с подробной информацией о нем.
-
Нажмите на кнопку Перевыпустить токен в нижней части карточки. Система выпустит новый API-токен и отобразит соответствующее уведомление. Предыдущий токен бота станет недействительным.
Удаление API-токена
Чтобы удалить API-токен, необходимо удалить связанного с ним бота:
-
Перейдите в раздел Настройки → Пользователи. Система отобразит сведения о доступных пользователях.
-
Наведите курсор на строку нужного бота в списке. Нажмите на кнопку Удалить (
), которая отображается в правой части строки. Отобразится окно подтверждения удаления бота. -
Нажмите на кнопку Удалить. Система удалит бота и отобразит соответствующее уведомление. Удаленный бот будет исключен из списка пользователей. API-токен, связанный с ботом, станет недействительным.
