このページで
usergroup.update
説明
object usergroup.update(object/array userGroups)
このメソッドは、既存のユーザーグループを更新するためのものです。
このメソッドはスーパ管理者ユーザータイプでのみ利用可能です。 このメソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメーター
(object/array) 更新するユーザーグループのプロパティ。
各ユーザーグループには usrgrpid プロパティを定義する必要があり、他のすべてのプロパティはオプションです。
渡されたプロパティのみが更新され、他のすべては変更されません。
標準のユーザーグループプロパティに加えて、このメソッドは以下のパラメーターを受け付けます。
| パラメーター | 型 | 説明 |
|---|---|---|
| hostgroup_rights | object/array | ユーザーグループに割り当てられている現在の権限を置き換えるホストグループの権限。 |
| 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.