usergroup.delete

説明

object usergroup.delete(array userGroupIds)

このメソッドではユーザーグループを削除できます。

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

パラメータ

(array) 削除するユーザーグループのID

戻り値

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

例

複数のユーザーグループ削除

二つのユーザーグループを削除します

Request:

{
           "jsonrpc": "2.0",
           "method": "usergroup.delete",
           "params": [
               "20",
               "21"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

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

ソース

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

Documentation

usergroup.delete

説明

パラメータ

戻り値

例

複数のユーザーグループ削除

ソース