Documentation
usergroup.get
描述
integer/array usergroup.get(object parameters)该方法允许根据给定的参数检索用户组。
此方法适用于任何类型的用户。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见 User roles。
参数
(object) 参数定义了期望的输出。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| mfaids | ID/array | 仅返回具有给定 MFA 方法的用户组。 参数行为: - 适用于 Super admin 类型用户（自 Zabbix 7.0.9 起） |
| 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 | 返回的 User group object 属性。 自 Zabbix 7.0.9 起，Admin 和 User 类型的用户只能检索以下属性： usrgrpid、name、gui_access、users_status、debug_mode、mfa_status。默认值： 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 | |
| selectRights (deprecated) |
query | 此参数已弃用，请改用 selectHostGroupRights 或 selectTemplateGroupRights。在 rights 属性中返回用户组权限。有关 主机 组的访问级别的列表，请参考 权限。 |
返回值
(integer/array) 返回以下之一：
- objects 的 array；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
获取已启用的用户组
检索所有启用的用户组。
执行请求:
{
"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() 方法位于 ui/include/classes/api/services/CUserGroup.php 文件中。