usergroup.update

説明

object usergroup.update(object/array userGroups)

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

パラメータ

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

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

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

戻り値

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

例

ユーザーグループの無効化

ユーザーグループを無効にします

Request:

{  "jsonrpc": "2.0",  "method": "usergroup.update",  "params": {  "usrgrpid": "17",  "users_status": "1"  },  "auth": "038e1d7b1735c6a5436ee9eae095879e",  "id": 1 }

Response:

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

参照

• Permission

ソース

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