user.delete

説明

object user.delete(array users)

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

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

パラメーター

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

戻り値

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

例

複数のユーザーの削除

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

リクエスト:

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

レスポンス:

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

ソース

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