user.logout

Opis

string/object user.logout(array)

Ta metoda umożliwia wylogowanie z API i unieważnia bieżący token uwierzytelniający.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(array) Metoda akceptuje pustą tablicę.

Zwracane wartości

(boolean) Zwraca true, jeśli użytkownik został pomyślnie wylogowany.

Przykłady

Wylogowanie

Wyloguj się z API.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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