usergroup.get

Description

integer/array usergroup.get(object parameters)

The method allows to retrieve user groups according to the given parameters.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter	Type	Description
status	integer	Return only user groups with the given status. Refer to the user group page for a list of supported statuses.
userids	string/array	Return only user groups that contain the given users.
usrgrpids	string/array	Return only user groups with the given IDs.
selectTagFilters	query	Return user group tag based permissions in the `tag_filters` property. It has the following properties: `groupid` - `(string)` ID of the host group; `tag` - `(string)` tag name; `value` - `(string)` tag value.
selectUsers	query	Return the users from the user group in the `users` property.
selectHostGroupRights	query	Return user group host group rights in the `hostgroup_rights` property. It has the following properties: `permission` - `(integer)` access level to the host group; `id` - `(string)` ID of the host group. Refer to the user group page for a list of access levels to host groups.
selectTemplateGroupRights	query	Return user group template group rights in the `templategroup_rights` property. It has the following properties: `permission` - `(integer)` access level to the template group; `id` - `(string)` ID of the template group. Refer to the user group page for a list of access levels to template groups.
limitSelects	integer	Limits the number of records returned by subselects.
sortfield	string/array	Sort the result by the given properties. Possible values: `usrgrpid`, `name`.
countOutput	boolean	These parameters being common for all `get` methods are described in detail in the reference commentary.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean
selectRights (deprecated)	query	This parameter is deprecated, please use `selectHostGroupRights` or `selectTemplateGroupRights` instead. Return user group rights in the rights property. It has the following properties: `permission` - `(integer)` access level to the host group; `id` - `(string)` ID of the host group. Refer to the user group page for a list of access levels to host groups.

Return values

(integer/array) Returns either:

an array of objects;
the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieving enabled user groups

Retrieve all enabled user groups.

Request:

{
           "jsonrpc": "2.0",
           "method": "usergroup.get",
           "params": {
               "output": "extend",
               "status": 0
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "usrgrpid": "7",
                   "name": "Zabbix administrators",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "8",
                   "name": "Guests",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "11",
                   "name": "Enabled debug mode",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "12",
                   "name": "No access to the frontend",
                   "gui_access": "2",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "14",
                   "name": "Read only",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "18",
                   "name": "Deny",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               }
           ],
           "id": 1
       }

Source

CUserGroup::get() in ui/include/classes/api/services/CUserGroup.php.

Documentation