usergroup.create

説明

object usergroup.create(object/array userGroups)

このメソッドでは、新しいユーザーグループを作成できます。

このメソッドは、Super admin ユーザータイプでのみ利用できます。 このメソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。 詳細は、ユーザーロールを参照してください。

パラメータ

(object/array) 作成するユーザーグループ。

このメソッドは、標準のユーザーグループプロパティに加えて、以下のパラメータを受け付けます。

パラメータ Type 説明
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
}

レスポンス:

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

参照

ソース

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