创建

描述

object usergroup.create(object/array userGroups)

此方法用于创建新的用户组。

此方法仅适用于Super admin(超级管理员)类型的用户。可在用户角色设置中撤销调用该方法的权限,参阅用户角色获取详情。

参数

(object/array) 要创建的用户组。

除了 标准用户组属性, 此方法接受如下参数。

参数类型描述
hostgroup_rightsobject/array分配给用户组的权限
templategroup_rightsobject/array分配给用户组的模板组权限
tag_filtersarray分配给用户组的标签权限
usersobject/array需要添加到用户组的 用户

用户必须只定义userid属性。
rights
(deprecated)
object/array此参数已弃用,请改用 hostgroup_rightstemplategroup_rights
分配给用户组的权限

返回值

(object) 返回一个带有usrgrpids属性(其中包含被创建用户组ID)的对象,返回的ID的顺序与传递的用户组的顺序相匹配。

示例

创建一个用户组

创建一个用户组, 禁止其访问主机组”2” , 并向其添加一个用户。

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "usergroup.create",
  4. "params": {
  5. "name": "Operation managers",
  6. "hostgroup_rights": {
  7. "id": "2",
  8. "permission": 0
  9. },
  10. "users": [
  11. {
  12. "userid": "12"
  13. }
  14. ]
  15. },
  16. "id": 1
  17. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": {
  4. "usrgrpids": [
  5. "20"
  6. ]
  7. },
  8. "id": 1
  9. }

参考

来源

CUserGroup::create() in ui/include/classes/api/services/CUserGroup.php.