user.delete

Description

object user.delete(array users)

Cette méthode permet de supprimer des utilisateurs.

Cette méthode est uniquement disponible pour le type d’utilisateur Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

(array) ID des utilisateurs à supprimer.

Valeurs de retour

(object) Renvoie un objet contenant les identifiants des utilisateurs supprimés dans la propriété userids.

Exemples

Suppression de plusieurs utilisateurs

Supprimez deux utilisateurs.

Requête :

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

Réponse :

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

Source

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