Пользователь

/api/user методы.

DELETE /api/user/:id

Выключить пользователя User. Не удаляет пользователя User из БД, но вместо этого отключает его учетную запись.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • id целое число больше нуля.

GET /api/user/

Получить список пользователей Users для администраторов или менеджеров групп.

По умолчанию для администраторов возвращает только активных пользователей, а для менеджеров групп - только активных пользователей в группах, которыми они управляют.

  • Если status = deactivated, включает также деактивированных пользователей.

  • Если status = all, включает всех пользователей (активных и неактивных) .

  • Также поддерживает include_deactivated, который если true, то равен status=all; если false, то равен status=active. status и include_deactivated требует разрешения суперпользователя.

  • include_deactivated - это устаревшая связка для status и будет удалена в будущем релизе, пользователям предлагается использовать status. Если оба параметра переданы, status имеет приоритет.

    Для пользователей с сегментированными разрешениями вернет только себя.

    Использует limit, offset для разбивки на страницы. Использует query для фильтра по имени, фамилии, электронной почте. Также использует group_id для фильтров по группе id.

Параметры:

  • status строка или null.

  • query строка или null.

  • group_id целое число больше нуля или null.

  • include_deactivated допустимая логическая строка (true или false) или null.

GET /api/user/:id

Получить одного пользователя User. Вы должны получать себя или быть суперпользователем или менеджером группы.

Параметры:

  • id целое число больше нуля.

GET /api/user/current

Получить текущего пользователя User.

GET /api/user/recipients

Получить список пользователей Users. В списке будут только активные пользователи. Предназначен для не-администраторов, в отличие от GET /api/user.

  • Если видимость пользователей :all или пользователь является администратором, то в списке будут все пользователи.

  • Если видимость пользователей :group, то в списке будут только пользователи из той же группы, в которую входит пользователь (не считая группы “все пользователи”).

  • Если видимость пользователей :none или пользователь находится в песочнице, то в списке будет только сам пользователь.

POST /api/user/

Создать нового пользователя User. Возвращает 400, если адрес электронной почты уже занят.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • first_name непустая строка или null.

  • last_name непустая строка или null.

  • email допустимый адрес электронной почты.

  • user_group_memberships null или последовательность карт, где { :id -> , :is_group_manager (optional) -> }

  • login_attributes null или ключи атрибутов входа, должны быть ключевым словом или строкой.

POST /api/user/:id/send_invite

Повторно отправить электронное письмо с приглашением для данного пользователя.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • id целое число больше нуля.

PUT /api/user/:id

Обновление существующего активного пользователя User. Сам пользователь или суперпользователь могут обновлять информацию пользователя и группы. Администраторы групп могут только добавлять/удалять пользователей из групп, которыми они управляют.

Параметры:

  • email допустимый адрес электронной почты или null.

  • first_name непустая строка или null.

  • is_group_manager логическое значение или null.

  • locale null или строка, являющаяся допустимым двухбуквенным ISO-кодом языка или кодом сочетания “язык_страна”, например, en или en_US.

  • user_group_memberships null или последовательность карт, где { :id -> , :is_group_manager (optional) -> }

  • id целое число больше нуля.

  • is_superuser логическое значение или null.

  • login_attributes null или ключи атрибутов входа, должны быть ключевым словом или строкой.

  • last_name непустая строка или null.

PUT /api/user/:id/modal/:modal

Указать, что пользователь был проинформирован о всех тонкостях “Конструктора запросов”.

Параметры:

  • id целое число больше нуля.

  • modal

PUT /api/user/:id/password

Обновить пароль пользователя.

Параметры:

  • id целое число больше нуля.

  • password пароль.

  • old_password

  • request

PUT /api/user/:id/reactivate

Заново активировать пользователя с :id.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • id целое число больше нуля.

<< Назад к разделу API