user.logout

Description

string/object user.logout(array)

Cette méthode permet de se déconnecter de l'API et invalide le jeton d'authentification actuel.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations permettant d'appeler 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) La méthode accepte un tableau vide.

Valeurs retournées

(boolean) Retourne true si l'utilisateur a été déconnecté avec succès.

Exemples

Déconnexion

Se déconnecter de l’API.

Requête:

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

Réponse :

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

Voir également

Source

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