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

Метод и конечная точка

POST /login

Описание

Выполняет аутентификацию пользователя в системе Squadus. При успешной аутентификации возвращает идентификатор пользователя и токен доступа, которые необходимо использовать в заголовках всех последующих запросов.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
password	да	string	Пароль пользователя
email	нет*	string	Электронная почта пользователя
username	нет*	string	Имя пользователя
user	нет*	string	Идентификатор пользователя
code	нет	string	Код двухфакторной аутентификации

* Должен быть указан один из параметров: email, username или user.

Запрос

curl -X 'POST' \ \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/login' \ \
  -H 'accept: application/json' \ \
  -H 'Content-Type: application/json' \ \
  -d '{ \ \
  "username": "<USERNAME>",
  "password": "<PASSWORD>"
  }'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USERNAME> — имя пользователя;
• <PASSWORD> — пароль пользователя.

Ответ

200 — Successful login — Успешная аутентификация. Пример вывода:

{
  "status": "success",
  "data": {
    "userId": "7w9BMr9r78W4RNe8x",
    "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "me": {
      "_id": "7w9BMr9r78W4RNe8x",
      "name": "John Doe",
      "username": "john.doe",
      "status": "online"
    }
  }
}

401 — Unauthorized — Ошибка аутентификации. Пример вывода:

{
  "status": "error",
  "error": "Unauthorized",
  "message": "Invalid username or password"
}