Sidebar

manual:appendix:api:usergroup:exists

usergroup.exists

Description

boolean usergroup.exists(object filter)

This method checks if at least one user group that matches the given filter criteria exists.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
name string/array Names of the user groups.
node string Name of the node the user groups must belong to.

This will override the nodeids parameter.
nodeids string/array IDs of the nodes the user groups must belong to.

Return values

(boolean) Returns true if at least one user group that matches the given filter criteria exists.

Examples

Checking if a user group exists

Check if user group “Zabbix administrators”

Request:

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

Response:

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

See also

Source

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