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) 作成されたユーザーグループのIDを usrgrpids プロパティに含むオブジェクトを返します。 返される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
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "usrgrpids": [
            "20"
        ]
    },
    "id": 1
}

参照

ソース

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