usergroup.create
描述
object usergroup.create(object/array userGroups)
此方法用于创建新的用户组。
此方法仅适用于 Super admin 用户类型。 调用该方法的权限可以在用户角色设置中撤销。 有关更多信息,请参见 User roles。
参数
(object/array) 要创建的用户组。
除了标准用户组属性之外,该方法还接受以下参数。
| Parameter | Type | Description |
|---|---|---|
| hostgroup_rights | object/array | 要分配给用户组的主机组权限。 |
| templategroup_rights | object/array | 要分配给用户组的模板组权限。 |
| tag_filters | array | 要分配给用户组的基于标签的权限。 |
| users | object/array | 要添加到用户组的用户。 用户必须仅定义 userid 属性。 |
| rights (deprecated) |
object/array | 此参数已弃用,请改用 hostgroup_rights 或 templategroup_rights。要分配给用户组的权限。 |
返回值
(object) 返回一个对象,其中包含在 usrgrpids 属性下创建的用户组 ID。
返回的 ID 顺序与传入的用户组顺序一致。
示例
创建用户组
创建一个用户组 Operation managers,并拒绝其访问 主机组 "2",然后将一个用户添加到该组。
执行请求:
{
"jsonrpc": "2.0",
"method": "usergroup.create",
"params": {
"name": "Operation managers",
"hostgroup_rights": {
"id": "2",
"permission": 0
},
"users": [
{
"userid": "12"
}
]
},
"id": 1
}
响应:
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"20"
]
},
"id": 1
}
另请参阅
源代码
CUserGroup::create() 位于 ui/include/classes/api/services/CUserGroup.php。