user.checkAuthentication

Opis

object user.checkAuthentication

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

Wywołanie metody user.checkAuthentication z użyciem parametru 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 jej przedłużania.

Zachowanie parametru:
- obsługiwane jeśli ustawiono sessionid
sessionid string Token uwierzytelniania użytkownika.

Zachowanie parametru:
- wymagane jeśli token nie jest ustawiony
token string Token API użytkownika.

Zachowanie parametru:
- wymagane jeśli sessionid nie jest ustawiony

Zwracane wartości

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

Oprócz standardowych właściwości użytkownika zwracane są następujące informacje.

Właściwość Type Opis
auth_type integer Domyślne uwierzytelnianie dla użytkownika.

Listę możliwych wartości można znaleźć we właściwości authentication_type obiektu Authentication object.
debug_mode integer Określa, czy tryb debugowania jest włączony czy wyłączony dla użytkownika.

Listę możliwych wartości można znaleźć we właściwości debug_mode obiektu User group object.
deprovisioned boolean Określa, czy użytkownik należy do grupy wycofanych użytkowników.
gui_access string Metoda uwierzytelniania użytkownika do frontend.

Listę możliwych wartości można znaleźć we właściwości gui_access obiektu User group object.
secret string Losowy ciąg 32 znaków. Jest generowany podczas logowania użytkownika.

Właściwość secret nie jest zwracana, jeśli sesja użytkownika jest sprawdzana przy użyciu tokena API.
sessionid string Token uwierzytelniający, który musi być używany w kolejnych żądaniach API.

Właściwość sessionid nie jest zwracana, jeśli sesja użytkownika jest sprawdzana przy użyciu tokena API.
type integer Typ użytkownika.

Listę możliwych wartości można znaleźć we właściwości type obiektu Role object.
userip string Adres IP użytkownika.

Przykłady

Sprawdzenie uwierzytelnienia przy użyciu tokenu uwierzytelniającego

Sprawdź i przedłuż sesję użytkownika przy użyciu tokenu uwierzytelniającego użytkownika oraz zwróć dodatkowe informacje o użytkowniku.

Żądanie:

{
    "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",
        "userdirectoryid": "0",
        "ts_provisioned": "0",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "0",
        "deprovisioned": false,
        "auth_type": 0,
        "sessionid": "673b8ba11562a35da902c66cf5c23fa2",
        "secret": "0e329b933e46984e49a5c1051ecd0751"
    },
    "id": 1
}
Sprawdzenie uwierzytelnienia przy użyciu tokena API

Sprawdź sesję użytkownika przy użyciu tokena API użytkownika i zwróć dodatkowe informacje o użytkowniku.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "user.checkAuthentication",
    "params": {
        "token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
    },
    "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": "1355919338",
        "rows_per_page": "50",
        "timezone": "Europe/Riga",
        "roleid": "3",
        "userdirectoryid": "0",
        "ts_provisioned": "0",
        "debug_mode": 0,
        "deprovisioned": false,
        "gui_access": "1",
        "mfaid": 0,
        "auth_type": 0,
        "type": 3,
        "userip": "127.0.0.1"
    },
    "id": 1
}

Źródło

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