user.create

説明

object user.create(object/array users)

このメソッドは新しいユーザーを作成します。

このメソッドはスーパ管理者ユーザータイプでのみ利用可能です。 このメソッドを呼び出す権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。

ユーザーパスワードの強度は、認証APIで定義されたパスワードポリシールールに従って検証されます。詳細は認証APIを参照してください。

パラメータ

(object/array) 作成するユーザー。

標準のユーザーのプロパティに加えて、このメソッドは以下のパラメータを受け付けます。

パラメータ 型 説明
usrgrps array ユーザーを追加するユーザーグループ。

ユーザーグループにはusrgrpidプロパティのみを定義する必要があります。
medias array 作成するユーザーメディア。

戻り値

(object) useridsプロパティの下で作成されたユーザーのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたユーザーの順序と一致します。

例

ユーザーの作成

新しいユーザーを作成し、ユーザーグループに追加し、新しいメディアを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "user.create",
    "params": {
        "username": "John",
        "passwd": "Doe123",
        "roleid": "5",
        "usrgrps": [
            {
                "usrgrpid": "7"
            }
        ],
        "medias": [
            {
                "mediatypeid": "1",
                "sendto": [
                    "[email protected]"
                ],
                "active": 0,
                "severity": 63,
                "period": "1-7,00:00-24:00"
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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