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

19 апреля 2024

ID 242752

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

Запрос

Заголовок:

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

Тело:

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

Пример тела запроса:

{

    user: {

        fullName: 'John Doe',

        shortName: 'John',

        email: 'some@email.com'

    },

    group: {

        id: '627d5c63f0672a10fbac23bb'

    }

}

Ответ

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

Пример ответа:

{

    user: {

        id: '627b4aa62344090b598f7435'

    }

}

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

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

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!