user.logout

Beschreibung

string/object user.logout(array)

Mit dieser Methode können Sie sich von der API abmelden und das aktuelle Authentifizierungstoken ungültig machen.

Diese Methode steht Benutzern jeden Typs zur Verfügung. 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.