[comment]: # translation:outdated

[comment]: # ({ce8d2bd2-ce8d2bd2})
# 查询用户组

[comment]: # ({/ce8d2bd2-ce8d2bd2})

[comment]: # ({cb58ccc3-ef79b8a9})
### 描述

`integer/array usergroup.get(object parameters)`

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

::: noteclassic
此方法只有*Super admin(超级管理员)*用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看[用户角色](/manual/web_interface/frontend_sections/administration/user_roles).
:::

[comment]: # ({/cb58ccc3-ef79b8a9})

[comment]: # ({2bb94e86-4be9c06e})
### 参数

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

该方法支持以下参数.

|参数|[类型](/manual/api/reference_commentary#data_types)|描述|
|---------|---------------------------------------------------|-----------|
|status|integer|只返回具有给定状态的用户组.<br><br>参阅 [用户组页面](object#user_group) 获取支持的状态列表.|
|userids|string/array|只返回包含给定用户的用户组.|
|usrgrpids|string/array|只返回具有给定ID的用户组.|
|selectTagFilters|query|在 [标签权限](/manual/api/reference/usergroup/object#tag_based_permission) 属性中返回用户标签权限.<br><br>它具有以下属性:<br>`groupid` - (string) 主机组ID;<br>`tag` - (string) 标签名;<br>`value` - (string) 标签值.|
|selectUsers|query|在 [用户](/manual/api/reference/user/object#user) 属性中返回用户组中的用户.|
|selectRights|query|在 [权限](/manual/api/reference/usergroup/object#permission) 属性中返回用户组权限.<br><br>它具有以下属性:<br>`permission` - (integer) 访问级别到主机组;<br>`id` - (string) 主机组的ID.<br><br>参阅 [用户组页面](object#permission) 获取主机组的访问级别列表.|
|limitSelects|integer|限制子选择返回的记录数.|
|sortfield|string/array|按照给定的属性对结果进行排序.<br><br>可接受的值: `usrgrpid`, `name`.|
|countOutput|boolean|`get` 方法的常用参数都被记录在 [参考说明](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/2bb94e86-4be9c06e})

[comment]: # ({7223bab1-7223bab1})
### 返回值

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

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 示例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({14d54c7d-62cd5d8e})
#### 查询启用的用户组

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

请求:

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

返回:

```json
{
    "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
}
```

[comment]: # ({/14d54c7d-62cd5d8e})

[comment]: # ({039ccba1-039ccba1})
### 参考

-   [用户](/manual/api/reference/user/object#user)

[comment]: # ({/039ccba1-039ccba1})

[comment]: # ({e72b2ac9-e72b2ac9})
### 来源

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

[comment]: # ({/e72b2ac9-e72b2ac9})