Перейти к основному содержимому
Версия: 2.0 (WIP)

API для взаимодействия со встроенной защитой системы

API для аутентификации и авторизации пользователей​

Для аутентификации и авторизации пользователей предназначены следующие URL:

  • по логину и паролю https://<host>/api/auth/v3/login, https://<host>/api/auth/v3/login/union и https://<host>/api/auth/v3/oauth_login
  • по API токену https://<host>/api/auth/v3/api_token_login
  • через OIDC https://<host>/api/auth/v3/oidc/login/{idp_name}

Подробности доступны по URL https://<host>/api/auth/docs#/auths.

Описание использования API токенов приведено в разделе API токен. Описание использования внешних провайдеров приведено в разделе Единая учётная запись.

API для управления пользователями​

Для управления пользователями предназначены URL https://<host>/api/auth/v4/users. Подробности доступны по URL https://<host>/api/auth/docs#/user_v4. Описание управления пользователями приведено в разделе Пользователи

API для получения логов аудита​

Для получения логов аудита предназначены следующие URL:

  • список доступных журналов аудита https://<host>/api/auth/v3/logs/audit_log_types
  • выполнение search запроса к Opensearch https://<host>/api/auth/v3/logs/{audit_log_type}/search
  • выполнение field_caps запроса к Opensearch https://<host>/api/auth/v3/logs/{audit_log_type}/field_caps

Подробности доступны по URL https://<host>/api/auth/docs#/logs.

API для управления настройками безопасности​

Для управления настройками предназначены URL https://<host>/api/auth/v3/settings. Подробности доступны по URL https://<host>/api/auth/docs#/settings. Описание управления настройками приведено в разделе Переменные раздела Security

Пример использования API​

В этом примере для выполнения запросов используется утилита curl.

Вход в систему:

curl -i --location 'localhost/api/auth/v3/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "login": "login",
    "password": "password"
}'

Получение списка пользователей

curl -i --location 'localhost/api/auth/v4/users' \
--header 'Cookie: session=ImIwYTNiOTAzNDI5MDQ0ZmM5ZDZlYzJkM2Y4OWU3Y2NjIg.adZyNQ.No3AB3Q9pW9WXpu7htDXaZNxHjE'