获取

描述

integer/array usergroup.get(object parameters)

该方法用于根据给定的参数检索用户组。

此方法适用于任何类型的用户。可在用户角色设置中撤销调用该方法的权限，参阅用户角色获取详情。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数类型描述
mfaidsID/array仅返回具有给定MFA的用户组。
mfa_statusinteger仅返回具有给定MFA状态的用户组。

有关支持的状态列表，请参阅用户组页面。
statusinteger仅返回具有给定状态的用户组。

有关支持的状态列表，请参阅用户组页面。
useridsID/array仅返回包含给定用户的用户组。
usrgrpidsID/array仅返回具有给定id的用户组。
selectTagFiltersquery在 tag_filters属性中返回基于用户组标记的权限。
selectUsersquery返回 users 属性中用户组的用户。
selectHostGroupRightsquery在 hostgroup_rights 属性中返回用户组主机组权限。

有关对主机组的访问级别的列表，请参阅用户组页面。
selectTemplateGroupRightsquery在templategroup_rights 属性中返回用户组模板组权限。

有关模板组的访问级别列表，请参阅用户组页面。
limitSelectsinteger限制子选择返回的记录数。
sortfieldstring/array按给定的属性对结果进行排序。

可能的值: usrgrpid, name.
countOutputboolean参考说明中详细描述了所有 get方法的通用参数。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean
selectRights
(deprecated)		query此参数已弃用，请改用 selectHostGroupRights或selectTemplateGroupRights。
在 rights 属性中返回用户组权限。
有关主机组访问级别的列表，请参阅用户组页面。

返回值

(integer/array) 返回结果二选一:

  • 一个对象数组;
  • 检索对象的计数（使用 countOutput 参数时）。

示例

检索已启用的用户组

检索所有已启用的用户组。

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "usergroup.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "status": 0
  7.            },
  8.            "id": 1
  9.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "usrgrpid": "7",
  6.                    "name": "Zabbix administrators",
  7.                    "gui_access": "0",
  8.                    "users_status": "0",
  9.                    "debug_mode": "1",
  10.                    "userdirectoryid": "0",
  11.                    "mfa_status": "0",
  12.                    "mfaid": "0"
  13.                },
  14.                {
  15.                    "usrgrpid": "8",
  16.                    "name": "Guests",
  17.                    "gui_access": "0",
  18.                    "users_status": "0",
  19.                    "debug_mode": "0",
  20.                    "userdirectoryid": "0",
  21.                    "mfa_status": "0",
  22.                    "mfaid": "0"
  23.                },
  24.                {
  25.                    "usrgrpid": "11",
  26.                    "name": "Enabled debug mode",
  27.                    "gui_access": "0",
  28.                    "users_status": "0",
  29.                    "debug_mode": "1",
  30.                    "userdirectoryid": "0",
  31.                    "mfa_status": "0",
  32.                    "mfaid": "0"
  33.                },
  34.                {
  35.                    "usrgrpid": "12",
  36.                    "name": "No access to the frontend",
  37.                    "gui_access": "2",
  38.                    "users_status": "0",
  39.                    "debug_mode": "0",
  40.                    "userdirectoryid": "0",
  41.                    "mfa_status": "0",
  42.                    "mfaid": "0"
  43.                },
  44.                {
  45.                    "usrgrpid": "14",
  46.                    "name": "Read only",
  47.                    "gui_access": "0",
  48.                    "users_status": "0",
  49.                    "debug_mode": "0",
  50.                    "userdirectoryid": "0",
  51.                    "mfa_status": "0",
  52.                    "mfaid": "0"
  53.                },
  54.                {
  55.                    "usrgrpid": "18",
  56.                    "name": "Deny",
  57.                    "gui_access": "0",
  58.                    "users_status": "0",
  59.                    "debug_mode": "0",
  60.                    "userdirectoryid": "0",
  61.                    "mfa_status": "0",
  62.                    "mfaid": "0"
  63.                }
  64.            ],
  65.            "id": 1
  66.        }

参考

来源

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