users.get_groups

Возвращает все группы пользователей.

Параметры

Название	Описание
—	Метод не имеет параметров

Пример

Получение всех групп, к которым может принадлежать пользователь:

instantcms_site.ru/api/method/users.get_groups?api_key=API_KEY

Результат

После успешного выполнения возвращает объект, содержащий общее число групп в поле count, массив самих групп в поле items и параметр sig, содержащий 32-х символьный код, который потом нужно передать одноименным параметром в запросы изменения принадлежности к группам. sig привязан к конкретному домену сайта и к ip адресу посетителя.

Каждый объект поля (из объекта items) состоит из ячеек:

Название	Описание
id	id группы. По этому параметру идёт привязка пользователей.
title	Название группы.
name	Системное имя.
is_public	Группу можно выбрать при регистрации.
is_fixed	Флаг, что группа системная.
is_filter	Выводить группу в фильтре пользователей.

Коды ошибок

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

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