usergroup.update

説明

object usergroup.update(object/array userGroups)

このメソッドは、既存のユーザーグループを更新できます。

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

パラメータ

(object/array) 更新するユーザーグループのプロパティ。

各ユーザーグループについて usrgrpid プロパティを定義する必要があり、その他の プロパティはすべて任意です。渡されたプロパティのみが更新され、その他の プロパティは変更されません。

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

パラメータ 型 説明
hostgroup_rights object/array ユーザーグループに現在割り当てられている権限を置き換える、ホストグループの権限。
templategroup_rights object/array ユーザーグループに現在割り当てられている権限を置き換える、テンプレートグループの権限。
tag_filters array ユーザーグループに現在割り当てられている権限を置き換える、タグベースの権限。
users object/array ユーザーグループに現在割り当てられているユーザーを置き換える、ユーザー。

ユーザーには userid プロパティのみを定義する必要があります。
rights
(非推奨)		 object/array このパラメータは非推奨です。代わりに hostgroup_rights または templategroup_rights を使用してください。
ユーザーグループに割り当てる権限。

戻り値

(object) usrgrpidsプロパティの下で更新されたユーザーグループのIDを含むオブジェクトを返します。

例

ユーザーグループの有効化と権限の更新

ユーザーグループを有効化し、ホストグループ「2」と「4」に対する読み書きアクセス権を付与します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "usergroup.update",
    "params": {
        "usrgrpid": "17",
        "users_status": "0",
        "hostgroup_rights": [
            {
                "id": "2",
                "permission": 3
            },
            {
                "id": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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