获取

描述

integer/array usergroup.get(object parameters)

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

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

参数

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

该方法支持以下参数。

参数 类型 描述
mfaids ID/array 仅返回具有给定 MFA 方法的用户组。

参数行为：
- 对 Super admin 类型用户 支持
mfa_status integer 仅返回具有给定 MFA 状态的用户组。

支持的状态列表请参见用户组页面。
status integer 仅返回具有给定状态的用户组。

支持的状态列表请参见用户组页面。
userids ID/array 仅返回包含给定用户的用户组。
usrgrpids ID/array 仅返回具有给定 ID 的用户组。
selectTagFilters query 在 tag_filters 属性中返回用户组基于标签的权限。
selectUsers query 在 users 属性中返回该用户组中的用户。

有关基于用户类型的限制，请参见 user.get。
selectHostGroupRights query 在 hostgroup_rights 属性中返回用户组主机组权限。

主机组访问级别列表请参见用户组页面。
selectTemplateGroupRights query 在 templategroup_rights 属性中返回用户组模板组权限。

模板组访问级别列表请参见用户组页面。
limitSelects integer 限制子选择返回的记录数。
output query 要返回的用户组对象属性。

Admin 和 User 类型用户只能检索以下属性：usrgrpid、name、gui_access、users_status、debug_mode、mfa_status。

默认值：extend。
sortfield string/array 按给定属性对结果进行排序。

可选值：usrgrpid、name。
countOutput boolean 这些参数在参考说明中进行了描述。
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

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

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

示例

检索已启用的用户组

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

请求:

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

响应:

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

参考

来源

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