Добавление ключей API
На странице Ключи API можно сгенерировать ключи API. Ключ API — это один из способов аутентификации в системе, который может быть использован внешними ИС для работы с системой. Ключи API используются в том числе агентами мониторинга для аутентификации на сервере приложения.
Атрибуты ключа API:
- Название ключа — должно быть уникальным (можно изменить в профиле ключа, во вкладке Основное)
- Значение ключа — уникальная последовательность символов, генерируется автоматически при создании ключа
- Режим аутентификации — с помощью какого атрибута будет проходить аутентификация
- Доступ к пространствам — к каким пространствам данных имеет доступ ключ
Возможные действия:
- Добавить ключ.
- При нажатии значка контекстного меню появляется список выбора действий с данным элементом:
- При нажатии Настроить происходит переход в профиль ключа во вкладку Привилегии
- Удалить (кнопка активна, когда выбран хотя бы один ключ)
- Поиск необходимого ключа.
Когда нет загруженных ключей в системе, при добавлении стандартного ключа его значение генерируется автоматически.
Значение ключа отображается полностью только один раз — в момент генерации. Если хотите просмотреть ключ позже, сохраните его. После генерации он больше не отображается на странице полностью.
Необходимо контролировать уникальность названия ключа API:
- Cертификат является файлом с расширением .crt или .cert
- Обновить сертификат API ключа возможно. Для этого нужно загрузить новый сертификат в профиле ключа. Старый сертификат становится недействительным
- Для предустановленного безопасного API ключа используется имя Агент мониторинга
При добавлении ключа выберите режим аутентификации:
- SSL-сертификат
- Стандартный
- Active Directory
- Стандартная Windows
При выборе SSL-сертификата можно:
- Задать название ключа API
- Загрузить сертификат (можно использовать самоподписанный сертификат)
- Удалить загруженный файл
В профиле ключа API с аутентификацией по SSL-сертификату отображается его отпечаток.
При выборе Стандартный можно задать название ключа API.
При выборе режима Active Directory серверная программа (внешняя система, скрипт) при получении сессии поверх значения ключа однократно проходит Kerberos-аутентификацию под доменной учетной записью. Проверка выполняется один раз, при получении сессии. Дальнейшие запросы передаются по выданной сессии без повторной аутентификации. На сервере под Linux аутентификация выполняется по протоколу Kerberos. Подробнее о настройке ключа с авторизацией Active Directory, времени жизни сессии и диагностике — в разделе Ключ API с авторизацией Active Directory.
Тип аутентификации Стандартная Windows (NTLM) на сервере под Linux не поддерживается. Используйте режим Active Directory.
Далее в привилегиях ключа API установите необходимые операции доступа для ключа API. Подробнее с привилегиями в системе можно ознакомиться в разделе Ролевая модель.
Во вкладке Пространства для ключа API настраивается доступ на просмотр или изменение пространств. Чтобы предоставить доступ, нажмите кнопку + Доступ, выберите необходимые пространства и нажмите Сохранить.
Во вкладке Основное можно изменить название ключа и просмотреть его режим аутентификации.
На стороне внешней системы необходимо произвести настройку HTTPS-соединения, хранилища сертификатов, а также клиентских сертификатов. После чего можно выполнять GraphQL-запросы к системе. Для возможности соединения в системе в обязательном порядке должна быть выполнена настройка клиентской авторизации.
Была ли статья полезна?