Zabbix Documentation 2.2

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

ru:manual:api:reference:usergroup:exists

usergroup.exists

Описание

логическое usergroup.exists(объект фильтр)

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

Параметры

(объект) Критерий по которому производить поиск.

Критериями поиска поддерживатся следующие параметры.

Параметр Тип Описание
name строка/массив Имена групп пользователей.
node строка Имя ноды, которой должны принадлежать группы пользователей.

Этот параметр переписывает параметр nodeids.
nodeids строка/массив ID нод, которым должны принадлежать группы пользователей.

Возвращаемые значения

(логический) Возвращает true, если имеется по крайней мере одна группа пользователей, которая соответствует заданному фильтром критерию.

Пример

Проверка наличия группы пользователей

Проверка наличия группы пользователей с именем “Zabbix administrators”

Запрос:

{
    "jsonrpc": "2.0",
    "method": "usergroup.exists",
    "params": {
        "name": "Zabbix administrators"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

Смотрите также

Исходный код

CUserGroup::exists() в frontends/php/api/classes/CUserGroup.php.