Документация InstantCMS

для администраторов и разработчиков

Инструменты пользователя

Инструменты сайта


manual:components:api:methods:users-remove_from_groups

users.remove_from_groups

Убирает пользователя из групп. Обратите внимание, действия возможны только для пользователей, не являющимися администраторами.

Параметры

Название Описание
user_id id пользователя, которого нужно исключить из переданных групп. Положительное число. Параметр обязательный.
group_ids Массив id групп, из которых нужно исключить пользователя. Список всех групп можно получить при помощи метода users.get_groups. Параметр обязательный.
sig Параметр, полученный от результата метода users.get_groups или иного метода, возвращающего данный параметр. Параметр привязан к ip адресу клиента и к домену сайта. Это обязательный параметр.

Пример

instantcms_site.ru/api/method/users.remove_from_groups?api_key=API_KEY&sig=SIG&group_ids[]=3&user_id=3

Результат

После успешного выполнения возвращает объект, содержащий поля success (true если группа была исключена, false, если к указанной группе пользователь не принадлежал) и groups с текущим массивом групп пользователя.

Коды ошибок

В ходе выполнения также могут произойти общие ошибки.


Назад к описанию методов API

manual/components/api/methods/users-remove_from_groups.txt · Последнее изменение: 06.05.2017 19:40 — fuze