查询用户组

描述

integer/array usergroup.get(object parameters)

该方法允许根据给定的参数检索用户组.

此方法只有Super admin(超级管理员)用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看用户角色.

参数

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

该方法支持以下参数.

参数类型描述
statusinteger只返回具有给定状态的用户组.

参阅 用户组页面 获取支持的状态列表.
useridsstring/array只返回包含给定用户的用户组.
usrgrpidsstring/array只返回具有给定ID的用户组.
selectTagFiltersquery在 标签权限 属性中返回用户标签权限.

它具有以下属性:
groupid - (string) 主机组ID;
tag - (string) 标签名;
value - (string) 标签值.
selectUsersquery在 用户 属性中返回用户组中的用户.
selectRightsquery在 权限 属性中返回用户组权限.

它具有以下属性:
permission - (integer) 访问级别到主机组;
id - (string) 主机组的ID.

参阅 用户组页面 获取主机组的访问级别列表.
limitSelectsinteger限制子选择返回的记录数.
sortfieldstring/array按照给定的属性对结果进行排序.

可接受的值: usrgrpid, name.
countOutputbooleanget 方法的常用参数都被记录在 参考说明.
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

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

  • 一个对象数组;
  • 如果使用 countOutput 参数，返回检索到的对象总数.

示例

查询启用的用户组

查询所有启用状态的用户组.

请求:

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

返回:

  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.                },
  11.                {
  12.                    "usrgrpid": "8",
  13.                    "name": "Guests",
  14.                    "gui_access": "0",
  15.                    "users_status": "0",
  16.                    "debug_mode": "0"
  17.                },
  18.                {
  19.                    "usrgrpid": "11",
  20.                    "name": "Enabled debug mode",
  21.                    "gui_access": "0",
  22.                    "users_status": "0",
  23.                    "debug_mode": "1"
  24.                },
  25.                {
  26.                    "usrgrpid": "12",
  27.                    "name": "No access to the frontend",
  28.                    "gui_access": "2",
  29.                    "users_status": "0",
  30.                    "debug_mode": "0"
  31.                },
  32.                {
  33.                    "usrgrpid": "14",
  34.                    "name": "Read only",
  35.                    "gui_access": "0",
  36.                    "users_status": "0",
  37.                    "debug_mode": "0"
  38.                },
  39.                {
  40.                    "usrgrpid": "18",
  41.                    "name": "Deny",
  42.                    "gui_access": "0",
  43.                    "users_status": "0",
  44.                    "debug_mode": "0"
  45.                }
  46.            ],
  47.            "id": 1
  48.        }

参考

来源

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