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

REST API

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

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

  • по логину и паролю https://<host>/api/auth/v3/login_without_session, используется в методе Basic Auth
  • по API токену https://<host>/api/auth/v3/api_token_login, используется в методе Bearer Token

Подробности доступны в Swagger API по URL https://<host>/api/auth/docs#/auths или можно перейти выбрав на главной странице системы Памир в правом верхнем углу иконку с символом ?, на открывшейся странице документации в левом нижнем углу выбрать элемент Swagger API и далее сервис auth.

Метод доступа Basic Auth​

Метод Basic Auth предоставляет доступ посредством как локальной учётной записи, так и учётной записи LDAP. Наименование записи в БД системы Памир для LDAP сервера задается в заголовке X-LDAP-Name HTTP-запросов. Для создания заголовка Authorization в Basic Auth, нужно сделать следующее:

  • создать единую строку, соединив имя пользователя и пароль двоеточием
  • преобразовать объединенную строку в формат Base64

Пример использования API для локальной учётной записи c именем пользователя mylogin и паролем mypassword.

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

curl --location 'localhost/api/auth/v4/users' \
--header 'Authorization: Basic bXlsb2dpbjpteXBhc3N3b3Jk'

Пример использования API для учётной записи LDAP c именем пользователя mylogin и паролем mypassword.

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

curl --location 'localhost/api/auth/v4/users' \
--header 'X-LDAP-Name: myldap' \
--header 'Authorization: Basic bXlsb2dpbjpteXBhc3N3b3Jk'

Метод доступа Bearer Token​

Метод Bearer Token предоставляет доступ посредством локальной учётной записи, которой соответствует API токен. Описание использования API токенов приведено в разделе API токен.

Пример использования API для локальной учётной записи c API токеном d1353cc52b864654e49bc5e18895d968200a5a4a7804512d03509978bb79fdd7.

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

curl --location 'localhost/api/auth/v4/users' \
--header 'Authorization: Bearer d1353cc52b864654e49bc5e18895d968200a5a4a7804512d03509978bb79fdd7'

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

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

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

Подробности доступны в Swagger API по URL https://<host>/api/auth/docs#/auths или можно перейти выбрав на главной странице системы Памир в правом верхнем углу иконку с символом ?, на открывшейся странице документации в левом нижнем углу выбрать элемент Swagger API и далее сервис auth.

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

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