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