Получение информации о нескольких пользователях

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

POST /users.info

Описание

Возвращает информацию о нескольких пользователях по их ID или именам.

Параметры

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

Название	Обязательный	Тип данных	Описание
usersIds	нет	array	Список идентификаторов пользователей
usersNames	нет	array	Список имен пользователей в формате firstname.lastname

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.info' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "usersIds": [
  "<USER_ID_1>",
  "<USER_ID_2>"
  ]
  }'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <USER_ID_1>, <USER_ID_2> — идентификаторы пользователей, информацию о которых необходимо получить.

Ответ

200 — Information about a users — Информация о пользователях. Пример вывода:

{
  "success": true,
  "users": [
    {
      "_id": "7w9BMr9r78W4RNe8x",
      "name": "John Doe",
      "username": "john.doe",
      "status": "online",
      "roles": ["user"],
      "active": true
    },
    {
      "_id": "8x9CNSs0s89X5SOf9y",
      "name": "Jane Smith",
      "username": "jane.smith",
      "status": "away",
      "roles": ["admin"],
      "active": true
    }
  ]
}