user.delete

Beschrijving

object user.delete(array users)

Deze methode maakt het mogelijk om gebruikers te verwijderen.

Deze methode is alleen beschikbaar voor gebruikers met het type Super admin. Toestemming om de methode aan te roepen kan worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(array) ID's van gebruikers om te verwijderen.

Retourwaarden

(object) Retourneert een object dat de ID's van de verwijderde gebruikers bevat onder de eigenschap userids.

Voorbeelden

Het verwijderen van meerdere gebruikers

Verwijder twee gebruikers.

Verzoek:

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

Reactie:

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

Bron

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