user.logout

Beschreibung

string/object user.logout(array)

Diese Methode ermöglicht die Abmeldung von der API und macht das aktuelle Authentifizierungs-Token ungültig.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(array) Die Methode akzeptiert ein leeres Array.

Rückgabewerte

(boolean) Gibt true zurück, wenn der Benutzer erfolgreich abgemeldet wurde.

Beispiele

Abmelden

Von der API abmelden.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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