Sidebar

zh:manual:api:reference:user:create

user.create

描述

object user.create(object/array users)

此方法允许创建新的用户。

Description

object user.create(object/array users)

This method allows to create new users.

Parameters

(object/array) 要创建的用户.

该方法接受有 标准用户属性的用户。

属性 类型 说明
passwd
(required)
string 用户密码。
usrgrps
(required)
array 用户添加到的组。

用户组必须有存在的 usrgrpid 属性定义。
user_medias array 为用户创建媒体。

Parameters

(object/array) Users to create.

Additionally to the standard user properties, the method accepts the following parameters.

Parameter Type Description
passwd
(required)
string User's password.
usrgrps
(required)
array User groups to add the user to.

The user groups must have the usrgrpid property defined.
user_medias array Medias to create for the user.

返回值

(object)返回一个包含创建值的ID的对象映射 userids 属性。返回的ID的顺序与传递的用户的顺序相匹配。

Return values

(object) Returns an object containing the IDs of the created users under the userids property. The order of the returned IDs matches the order of the passed users.

示例

Examples

创建一个用户

创建一个新用户, 把用户加入用户组同时添加用户媒体。

Creating a user

Create a new user, add him to a user group and create a new media for him.

Request:

{
    "jsonrpc": "2.0",
    "method": "user.create",
    "params": {
        "alias": "John",
        "passwd": "Doe123",
        "usrgrps": [
            {
                "usrgrpid": "7"
            }
        ],
        "user_medias": [
            {
                "mediatypeid": "1",
                "sendto": [
                    "[email protected]"
                ],
                "active": 0,
                "severity": 63,
                "period": "1-7,00:00-24:00"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "12"
        ]
    },
    "id": 1
}

参考

来源

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