usergroup.update

説明

object usergroup.update(object/array userGroups)

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

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

パラメータ

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

各ユーザーグループに対してusrgrpidプロパティを定義する必要があります。それ以外のすべてのプロパティはオプションです。渡されたプロパティのみが更新され、それ以外のプロパティは変更されません。

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

Parameter Type Description
hostgroup_rights object/array ユーザーグループに割り当てられている現在の権限を置き換えるホストグループの権限。
proxies object/array ユーザーグループにリンクするプロキシ。
プロキシにはproxyidプロパティのみを定義する必要があります。
proxy_groups object/array ユーザーグループにリンクするプロキシグループ。
プロキシグループにはproxy_groupidプロパティのみを定義する必要があります。
templategroup_rights object/array ユーザーグループに割り当てられている現在の権限を置き換えるテンプレートグループの権限。
tag_filters array ユーザーグループに割り当てられている現在の権限を置き換えるタグベースの権限。
users object/array ユーザーグループに割り当てられている現在のユーザーを置き換えるユーザー。

ユーザーにはuseridプロパティのみを定義する必要があります。

戻り値

(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.