user.delete

Descripción

object user.delete(array users)

Este método permite eliminar usuarios.

Este método solo está disponible para el tipo de usuario Super administrador. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para más información.

Parámetros

(array) IDs de los usuarios a eliminar.

Valores de retorno

(object) Devuelve un objeto que contiene los IDs de los usuarios eliminados bajo la propiedad userids.

Ejemplos

Eliminando varios usuarios

Eliminar dos usuarios.

Solicitud:

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

Respuesta:

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

Fuente

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