Перейти к содержанию

title: "Пользователь" summary: | /api/user методы. redirect_from: - /ru/docs/latest/api/user

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

/api/user методы.

DELETE /api/user/:id

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

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.

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 nullable string.

  • query nullable string.

  • group_id nullable value must be an integer greater than zero.

  • include_deactivated nullable value must be a valid boolean string ('true' or 'false').

GET /api/user/:id

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.

GET /api/user/current

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

GET /api/user/recipients

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

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

POST /api/user/

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

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

ПАРАМЕТРЫ:

  • first_name nullable value must be a non-blank string.

  • last_name nullable value must be a non-blank string.

  • email value must be a valid email address.

  • user_group_memberships nullable sequence of map where {:id -> , :is_group_manager (optional) -> }.

  • login_attributes nullable login attribute keys must be a keyword or string.

PUT /api/user/:id

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

ПАРАМЕТРЫ:

  • email nullable value must be a valid email address.

  • first_name nullable value must be a non-blank string.

  • is_group_manager nullable boolean.

  • locale nullable String must be a valid two-letter ISO language or language-country code e.g. en or en_US.

  • user_group_memberships nullable sequence of map where {:id -> , :is_group_manager (optional) -> }.

  • id value must be an integer greater than zero.

  • is_superuser nullable boolean.

  • login_attributes nullable login attribute keys must be a keyword or string.

  • last_name nullable value must be a non-blank string.

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

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.

  • modal

PUT /api/user/:id/password

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.

  • password password is too common.

  • old_password

  • request

PUT /api/user/:id/reactivate

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

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.