Аутентификация пользователя — Auth

Запросы выполняются от имени аутентифицированного пользователя.

Методы API учитывают:

  • Права пользователя.
  • Роль пользователя — выполняется проверка наличия у пользователя системной роли Администратор.
  • Срок действия пароля (если в настройках безопасности задано значение).

Если пользователь заблокирован, то он не может выполнять запросы по API.

Также доступна аутентификация в публичном API:

  • С помощью токена, полученного в SSO Keycloak (OpenID).
  • Под системным пользователем dataАdmin при включенной интеграции с Active Directory, которому доступно:
    • Получение логина и пароля от Workflow user, который обладает максимальными правами и видит все объекты в системе
    • Добавление с помощью скрипта системных пользователей, которых не видно в списке пользователей

Методы позволяют авторизоваться пользователю для выполнения запросов:

  • POST /api/v2/auth/token — метод позволяет получить или обновить токен доступа.
  • POST /api/v2/auth/wintoken — метод позволяет получить токен доступа с аутентификацией Windows.
  • POST /api/v2/auth/short-lived-token — метод позволяет получить короткоживущий токен:
    • Для отправки запроса необходимо передать время жизни короткоживущего токена в секундах (lifetime) в формате целого числа (по умолчанию 10 минут), значение не может превышать время жизни токена для публичного API (по умолчанию 1 час)
    • При успешном запросе в ответе будут содержаться следующие параметры:
      • access_token — токен доступа
      • token_type — тип токена (всегда bearer)
      • expires_in — время жизни токена (= lifetime)
      • refresh_token — токен доступа для получения нового access_token

Доступные версии: V1, V2.