user.create
説明
object user.create(object/array users)
このメソッドでは、新しいユーザーを作成できます。
このメソッドは、Super admin ユーザータイプでのみ利用できます。
メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳細は
ユーザーロール
を参照してください。
ユーザーパスワードの強度は、Authentication API で定義された パスワードポリシールールに従って検証されます。詳細は Authentication 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.