usergroup.get

描述

integer/array usergroup.get(object parameters)

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

该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles

参数

(object) 定义期望输出的参数.

该方法支持以下参数.

参数 数据类型 描述
status integer 仅返回具有指定状态的用户组.

参考用户组获取支持的状态列表.
userids string/array 仅返回包含指定用户的用户组.
usrgrpids string/array 仅返回具有指定ID的用户组.
selectTagFilters query 基于标签的权限属性中返回用户组标签权限.

具有以下属性:
groupid - (string) 主机组的ID;
tag - (string) 标签名称;
value - (string) 标签值.
selectUsers query 用户属性中返回用户组的用户.

参见user.get了解基于用户类型的限制.
selectRights query 权限属性中返回用户组权限.

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

参考权限获取主机组的访问级别列表.
limitSelects integer 限制子查询返回的记录数.
output query 要返回的User group object属性.

从Zabbix 6.0.38开始,AdminUser类型用户只能检索以下属性: usrgrpid, name, gui_access, users_status, debug_mode.

默认值: extend.
sortfield string/array 按指定属性排序结果.

可能的值有: usrgrpid, name.
countOutput boolean 这些参数在通用get方法参数中有描述.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) 返回以下两种结果之一:

  • 一个由array组成的objects数组
  • 检索到的objects数量(当使用了countOutput参数时)

示例

获取已启用的用户组

获取所有已启用的用户组.

请求:

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

响应:

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

另请参阅

来源

CUserGroup::get() 位于 ui/include/classes/api/services/CUserGroup.php 文件中。