Documentation
user.create
説明
object user.create(object/array users)
このメソッドは、新しいユーザーを作成します。
このメソッドは、Super adminタイプのユーザのみが使用できます。 このメソッドを呼び出す権限は、ユーザーロールの設定で無効にできます。 詳細はユーザーの役割を参照してください。
ユーザーのパスワード強度は、Authentication APIで定義されたパスワードポリシーに従って検証されます。 詳細はAuthenticationを参照してください。
パラメータ
(object/array) ユーザー作成
このメソッドは、Userオブジェクトのプロパティに加えて、次のパラメーターを受け取ります。
| パラメータ | タイプ | 説明 |
|---|---|---|
| usrgrps | array | 新規ユーザーを追加するユーザーグループusrgrpidプロパティを定義する必要があります。 |
| medias | array | 新規ユーザーに付与するユーザーメディア |
戻り値
(object) 作成されたユーザーのID(useridsプロパティ)を持つオブジェクトを返します。 返されるIDの順序は、渡したユーザーの順序と一致します。
例
ユーザー作成
新しいユーザーを作成します。その際に、ユーザーグループへの追加と新しいメディアの作成を行います。
Request:
{ "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" } ] }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
参照
ソース
CUser::create() in ui/include/classes/api/services/CUser.php.