role.delete

説明

object role.delete(array roleids)

このメソッドを使用すると、ロールを削除できます。

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

パラメーター

(array) 削除するユーザーの役割のID。

戻り値

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

例

複数のユーザーの役割の削除

2つのユーザーの役割を削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "role.delete",
    "params": [
        "4",
        "5"
    ],
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "roleids": [
            "4",
            "5"
        ]
    },
    "id": 1
}

ソース

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