usergroup.get

说明

integer/array usergroup.get(object parameters)

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

参数

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

该方法支持以下参数。

属性 类型 说明
status integer 只返回具有给定状态的用户组。 请参阅用户组页面以获取支持的状态列表。
userids string/array 只返回包含给定用户的用户组。
usrgrpids string/array 只返回具有给定ID的用户组。
with_gui_access integer 只返回具有给定前端身份验证方法的用户组。 有关支持的方法的列表，请参阅 用户组页面。
selectUsers query 在“users”属性中返回用户组中的用户。
selectRights query 在“权限”属性中返回用户组权限。 它具有以下属性：权限 - （整数）访问级别到主机组;id - （string）主机组的ID。有关主机组的访问级别列表，请参阅用户组页面。
limitSelects integer 限制子选择返回的记录数。
sortfield string/array 按照给定的属性对结果进行排序。 可能的值为：usrgrpid，name。
countOutput flag参考文献中详细描述了所有“获得”方法的常用参数。.
editable boolean
excludeSearch flag
filter object
limit integer
output query
preservekeys flag
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch flag

返回值

(integer/array) 返回：

  • 一组对象;

  • 如果已经使用“countOutput”参数，则检索到的对象的计数。

示例

Retrieving enabled user groups

Retrieve all enabled user groups.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "usergroup.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "status": 0
  7.     },
  8.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.     "id": 1
  10. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "usrgrpid": "7",
  6.             "name": "Zabbix administrators",
  7.             "gui_access": "0",
  8.             "users_status": "0",
  9.             "debug_mode": "1"
  10.         },
  11.         {
  12.             "usrgrpid": "8",
  13.             "name": "Guests",
  14.             "gui_access": "0",
  15.             "users_status": "0",
  16.             "debug_mode": "0"
  17.         },
  18.         {
  19.             "usrgrpid": "11",
  20.             "name": "Enabled debug mode",
  21.             "gui_access": "0",
  22.             "users_status": "0",
  23.             "debug_mode": "1"
  24.         },
  25.         {
  26.             "usrgrpid": "12",
  27.             "name": "No access to the frontend",
  28.             "gui_access": "2",
  29.             "users_status": "0",
  30.             "debug_mode": "0"
  31.         },
  32.         {
  33.             "usrgrpid": "14",
  34.             "name": "Read only",
  35.             "gui_access": "0",
  36.             "users_status": "0",
  37.             "debug_mode": "0"
  38.         },
  39.         {
  40.             "usrgrpid": "18",
  41.             "name": "Deny",
  42.             "gui_access": "0",
  43.             "users_status": "0",
  44.             "debug_mode": "0"
  45.         }
  46.     ],
  47.     "id": 1
  48. }

参见

来源

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