获取
描述
integer/array usergroup.get(object parameters)
该方法用于根据给定的参数检索用户组。
此方法适用于任何类型的用户。可在用户角色设置中撤销调用该方法的权限，参阅用户角色获取详情。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| mfaids | ID/数组 | 仅返回具有指定MFA方法的用户组。 参数行为: - 支持 超级管理员类型用户（自Zabbix 7.0.9版起） |
| mfa_status | 整数 | 仅返回具有指定MFA状态的用户组。 请参阅用户组页面以获取支持的状态列表。 |
| status | 整数 | 仅返回具有指定状态的用户组。 请参阅用户组页面以获取支持的状态列表。 |
| userids | ID/数组 | 仅返回包含指定用户的用户组。 |
| usrgrpids | ID/数组 | 仅返回具有指定ID的用户组。 |
| selectTagFilters | 查询 | 在tag_filters属性中返回用户组基于标签的权限。 |
| selectUsers | 查询 | 在users属性中返回用户组的用户。请参阅 user.get以获取基于用户类型的限制。 |
| selectHostGroupRights | 查询 | 在hostgroup_rights属性中返回用户组主机组权限。请参阅用户组页面以获取主机组的访问级别列表。 |
| selectTemplateGroupRights | 查询 | 在templategroup_rights属性中返回用户组模板组权限。请参阅用户组页面以获取模板组的访问级别列表。 |
| limitSelects | 整数 | 限制子查询返回的记录数。 |
| output | 查询 | 用户组对象属性返回。 自Zabbix 7.0.9版起，管理员和用户类型用户可能仅检索以下属性： usrgrpid，name，gui_access，users_status，debug_mode，mfa_status。默认： extend。 |
| sortfield | 字符串/数组 | 根据给定属性对结果进行排序。 可能的值： usrgrpid，name。 |
| countOutput | 布尔值 | 这些参数在参考说明中描述。 |
| editable | 布尔值 | |
| excludeSearch | 布尔值 | |
| filter | 对象 | |
| limit | 整数 | |
| preservekeys | 布尔值 | |
| search | 对象 | |
| searchByAny | 布尔值 | |
| searchWildcardsEnabled | 布尔值 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔值 | |
| selectRights (已废弃) |
查询 | 此参数已废弃，请改用selectHostGroupRights或selectTemplateGroupRights。在 rights属性中返回用户组权限。请参阅用户组页面以获取主机组的访问级别列表。 |
返回值
(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.