Table of Contents
usergroup.create
説明
object usergroup.create(object/array userGroups)
このメソッドは新しいユーザーグループを作成します。
このメソッドはスーパ管理者ユーザータイプでのみ利用可能です。 このメソッドの呼び出し権限は、ユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメーター
(object/array) 作成するユーザーグループ。
標準のユーザーグループプロパティに加えて、 このメソッドは以下のパラメーターを受け付けます。
| パラメーター | 型 | 説明 |
|---|---|---|
| hostgroup_rights | object/array | ユーザーグループに割り当てるホストグループの権限。 |
| templategroup_rights | object/array | ユーザーグループに割り当てるテンプレートグループの権限。 |
| tag_filters | array | ユーザーグループに割り当てるタグベースの権限。 |
| users | object/array | ユーザーグループに追加するユーザー。 ユーザーには useridプロパティのみが定義されている必要があります。 |
戻り値
(object) usrgrpidsプロパティの下で作成されたユーザーグループのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたユーザーグループの順序と一致します。
例
ユーザーグループの作成
ホストグループ"2"へのアクセスが拒否されたユーザーグループOperation managersを作成し、ユーザーを追加します。
{
"jsonrpc": "2.0",
"method": "usergroup.create",
"params": {
"name": "Operation managers",
"hostgroup_rights": {
"id": "2",
"permission": 0
},
"users": [
{
"userid": "12"
}
]
},
"id": 1
}レスポンス:
参照
ソース
CUserGroup::create() in ui/include/classes/api/services/CUserGroup.php.