user.delete

Description

object user.delete(array users)

Cette méthode permet de supprimer des utilisateurs.

Cette méthode est disponible uniquement pour les utilisateurs de type Super admin. Les autorisations d'appel de la méthode peuvent être révoquées dans les réglages du rôle d'utilisateur. Voir les Rôles utilisateur pour plus d'informations.

Paramètres

(array) ID des utilisateurs à supprimer.

Valeurs retournées

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

Exemples

Suppression de plusieurs utilisateurs

Supprimer deux utilisateurs

Requête :

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

Réponse :

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

Source

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