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版本开始,Admin和User类型用户只能检索以下属性: 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)
返回以下两种结果之一:
countOutput
参数,则返回检索到的objects数量。获取所有已启用的用户组。
请求:
{
"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 文件中。