Процедура авторизации

При авторизации пользователю присваивается текущая сессия. Многие запросы не смогут быть обработаны без этого шага. То же самое можно сказать и об операциях с проектами, наборами данных, колонками и т.д.

Авторизация может быть выполнена через сервер LDAP, для этого необходимо предварительно настроить сервер LDAP в Административном клиенте.

Нет необходимости использовать токен при входе в систему. В противном случае будет возвращена ошибка 500 (имя пользователя не указано).

Каждый открытый проект уменьшает количество доступных лицензий на 1. Когда сессия закончится из-за превышения лимита времени ожидания или пользователь выйдет из системы, лицензия будет снова доступна для работы. Для получения дополнительной информации см. здесь.

Авторизация на сервере PolyAnalyst 6.x

Авторизуйтесь на сервере PolyAnalyst 6.x, используя имя пользователя и пароль:

URL

/login

Метод

POST

Тип ответа

sync

Параметры запроса

Имя Тип Обязательный Описание

uname

строка

да

Имя пользователя.

pwd

строка

нет

Пароль.

useLDAP

число (0 или 1)

нет

Если установлено значение 1, то авторизация произойдет через LDAP-сервер.

svr

строка

нет

Адрес LDAP-сервера.

Тело запроса (application/json)

<отсутствует>

Примеры URL запросов

Авторизация с именем пользователя и паролем:

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/login?uname=user&pwd=password

Авторизация через сервер LDAP:

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/login?uname=user&pwd=password&useLDAP=1&svr=ldap.polyanalyst.com

Тело ответа (application/json)

{
  "result": "success"
}

где

Имя Тип Описание

result

строка

Результат операции.

Если авторизация прошла успешно, сервер вернет код 200 и сообщение в поле result. С этого момента текущая сессия будет авторизована. Все дальнейшие запросы в этой сессии буду выполняться в соответствии с правами зарегистрированного пользователя.

Если возникла ошибка, то сервер выдаст код ошибки 400 или 500 с детальной информацией.

Примеры ответов

Код Тело ответа и его описание

200

Авторизация прошла успешно.

{
  "result": "success"
}

500

Не удалось войти (имя пользователя не указано).

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Login failed - user name not specified"
    }
}

500

Не удалось войти (неверное имя пользователя).

{
  "error": {
    "code": 500,
    "title": "",
    "message": "User administrattor not found"
    }
}

500

Не удалось войти (неверный пароль).

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Login failed - password mismatch"
    }
}

500

Сервер PolyAnalyst выполняет восстановление базы данных и не может установить соединение в данный момент. Подождите некоторое время и повторите операцию.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "PolyAnalyst Server performs database recovery and cannot establish connection right now. Please wait a minute and retry operation"
    }
}

500

Ошибка LDAP-сервера по умолчанию.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Detecting default LDAP server error"
    }
}

500

Пустые пароли не поддерживаются для LDAP.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Empty passwords are not supported for LDAP"
    }
}

500

Адрес LDAP-сервера не аутентифицирован сервером PolyAnalyst.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "LDAP server 192.168.123.32 is not authenticated by PolyAnalyst server!"
  }
}