usergroup.create

说明

object usergroup.create(object/array userGroups) 此方法允许创建新的用户组。

参数

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

除了标准用户组属性之外, 该方法接受以下参数。

属性 类 说明
rights object/array 分配给组的权限
userids string/array 要添加到用户组的用户的ID。

返回值

(object) 返回包含“usrgrpids”属性下创建的用户组的ID的对象。 返回的ID的顺序与传递的用户组的顺序相匹配。

示例

Creating a user group

Create a user group, which denies access to host group "2", and add a user to it.

Request:

{
           "jsonrpc": "2.0",
           "method": "usergroup.create",
           "params": {
               "name": "Operation managers",
               "rights": {
                   "permission": 0,
                   "id": "2"
               },
               "userids": "12"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "usrgrpids": [
                   "20"
               ]
           },
           "id": 1
       }

参见

来源

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