This is a translation of the original English documentation page. Help us make it better.

user.logout

Beschrijving

string/object user.logout(array)

Deze methode maakt het mogelijk om uit te loggen bij de API en maakt de huidige authenticatietoken ongeldig.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(array) De methode accepteert een lege array.

Retourwaarden

(boolean) Retourneert true als de gebruiker succesvol is uitgelogd.

Voorbeelden

Uitloggen

Log uit bij de API.

Aanvraag:

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

Reactie:

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

Zie ook

Bron

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