usergroup.delete

説明

object usergroup.delete(array userGroupIds)

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

プロビジョニング解除されたユーザーグループ (認証のdisabled_usrgrpidに指定されたユーザーグループ) は削除できません。

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

パラメーター

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

戻り値

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

例

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

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

リクエスト:

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

レスポンス:

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

ソース

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