user.checkAuthentication

Opis

object user.checkAuthentication

Ta metoda sprawdza i przedłuża sesję użytkownika.

Wywołanie metody user.checkAuthentication z ustawionym parametrem sessionid domyślnie przedłuża sesję użytkownika.

Parametry

Metoda akceptuje następujące parametry.

Parametr Typ Opis
extend boolean Czy przedłużyć sesję użytkownika.

Wartość domyślna: "true". Ustawienie wartości na "false" pozwala sprawdzić sesję użytkownika bez przedłużania jej.

Używane, jeśli ustawiono sessionid.
sessionid string ID sesji użytkownika.

Wymagane, jeśli token nie jest ustawiony.
token string Token API użytkownika.

Wymagane, jeśli sessionid nie jest ustawiony.

Zwracane wartości

(object) Zwraca obiekt zawierający informacje o użytkowniku.

Przykłady

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "user.checkAuthentication",
           "params": {
               "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
           },
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": {
               "userid": "1",
               "username": "Admin",
               "name": "Zabbix",
               "surname": "Administrator",
               "url": "",
               "autologin": "1",
               "autologout": "0",
               "lang": "ru_RU",
               "refresh": "0",
               "theme": "default",
               "attempt_failed": "0",
               "attempt_ip": "127.0.0.1",
               "attempt_clock": "1355919038",
               "rows_per_page": "50",
               "timezone": "Europe/Riga",
               "roleid": "3",
               "type": 3,
               "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
               "debug_mode": 0,
               "userip": "127.0.0.1",
               "gui_access": 0
           },
           "id": 1
       }

Odpowiedź jest podobna do odpowiedzi na zapytanie User.login z parametrem "userData" mającym wartość True (różnica polega na tym, że dane użytkownika są pobierane przez identyfikator sesji, a nie przez nazwę użytkownika / hasło).

Źródło

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