Метод POST /openapi/v1/users

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

Запрос

Заголовок:

• Authorization – API-токен компании.

Тело:

• user – тип object – объект, содержащий персональную информацию о пользователе.
  • fullName – тип string – полное имя пользователя.
  • shortName – тип string – короткое имя пользователя.
  • email – тип string – адрес электронной почты пользователя.
• group – тип object – объект с информацией о группе, в которую пользователя необходимо назначить.
  • id – тип string – идентификатор группы.

Пример тела запроса: {     user: {         fullName: 'John Doe',         shortName: 'John',         email: 'some@email.com'     },     group: {         id: '627d5c63f0672a10fbac23bb'     } }

Ответ

• user – тип object – объект с информацией о созданном пользователе.
  • id – тип string – идентификатор пользователя.

Пример ответа: {     user: {         id: '627b4aa62344090b598f7435'     } }

Возможные ошибки:

• 400 – common-validation – ошибка валидации запроса.
• 401 – common-unauthorized – ошибка авторизации.
• 402 – no-available-license – недостаточно доступных лицензий, чтобы назначить пользователя в группу с запущенным обучением.
• 404 – group-does-not-exists – группа с указанным идентификатором у данной компании не существует.
• 429 – too-many-requests – превышено ограничение на количество запросов.
• 409 – user-email-already-exists-in-company – пользователь с указанным адресом электронной почты уже существует в компании.

В начало