Создание нового пользователя

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

POST /users.create

Описание

Создание нового пользователя. Требуются разрешения на создание пользователей.

Параметры

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

Название	Обязательный	Тип данных	Описание
email	да	string	Адрес электронной почты пользователя
name	да	string	Имя пользователя в формате Firstname Lastname
password	да	string	Пароль для учетной записи пользователя
username	да	string	Имя пользователя в формате firstname.lastname
active	нет	boolean	Статус активности пользователя (true/false)
bio	нет	string	Описание пользователя
nickname	нет	string	Псевдоним пользователя
statusText	нет	string	Текстовый статус пользователя
roles	нет	array	Роли пользователя
customFields	нет	object	Пользовательские поля

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.create' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "email": "<EMAIL>",
  "name": "<NAME>",
  "password": "<PASSWORD>",
  "username": "<USERNAME>",
  "active": true,
  "bio": "<BIO>",
  "nickname": "<NICKNAME>",
  "statusText": "<STATUS_TEXT>",
  "roles": [
  "<ROLE>"
  ],
  "customFields": {}
  }'

Где:

• <ENV> — окружение, на котором выполняется запрос (например, dev, test, prod);
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <EMAIL> — адрес электронной почты создаваемого пользователя;
• <NAME> — полное имя создаваемого пользователя;
• <PASSWORD> — пароль для учетной записи;
• <USERNAME> — уникальное имя пользователя в системе;
• <BIO> — краткая биография пользователя (необязательно);
• <NICKNAME> — псевдоним пользователя (необязательно);
• <STATUS_TEXT> — текстовый статус пользователя (необязательно);
• <ROLE> — роль пользователя (например, user, admin, moderator).

Ответ

200 — Created user — Пользователь создан. Пример вывода:

{
  "success": true,
  "user": {
    "_id": "7w9BMr9r78W4RNe8x",
    "name": "John Doe",
    "username": "john.doe",
    "nickname": "JD",
    "emails": [
      {
        "address": "john.doe@example.com",
        "verified": false
      }
    ],
    "status": "offline",
    "statusDefault": "online",
    "statusText": "Working",
    "bio": "Software Developer",
    "roles": ["user"],
    "active": true,
    "_updatedAt": "2026-06-24T10:00:00.000Z"
  }
}