user.checkAuthentication

Description

object user.checkAuthentication

Cette méthode vérifie et prolonge la session utilisateur.

L'appel de la méthode user.checkAuthentication à l'aide du paramètre sessionid prolonge la session utilisateur par défaut.

Paramètres

La méthode accepte les paramètres suivants.

Paramètre Type Description
extend boolean Indique s'il faut prolonger la session utilisateur.

Valeur par défaut : "true".
Définir la valeur sur "false" permet de vérifier la session utilisateur sans la prolonger.

Comportement du paramètre :
- pris en charge si sessionid est défini
sessionid string Jeton d'authentification de l'utilisateur.

Comportement du paramètre :
- obligatoire si token n'est pas défini
token string Jeton d'API de l'utilisateur.

Comportement du paramètre :
- obligatoire si sessionid n'est pas défini

Valeurs de retour

(object) Renvoie un objet contenant des informations sur l’utilisateur.

En plus des propriétés utilisateur standard, les informations suivantes sont renvoyées.

Propriété Type Description
auth_type integer Authentification par défaut pour l’utilisateur.

Consultez la propriété authentication_type de l’objet Authentication pour obtenir la liste des valeurs possibles.
debug_mode integer Indique si le mode de débogage est activé ou désactivé pour l’utilisateur.

Consultez la propriété debug_mode de l’objet Groupe d’utilisateurs pour obtenir la liste des valeurs possibles.
deprovisioned boolean Indique si l’utilisateur appartient à un groupe d’utilisateurs déprovisionnés.
gui_access string Méthode d’authentification de l’utilisateur pour l’interface web.

Consultez la propriété gui_access de l’objet Groupe d’utilisateurs pour obtenir la liste des valeurs possibles.
secret string Chaîne aléatoire de 32 caractères. Elle est générée lors de la connexion de l’utilisateur.

La propriété secret n’est pas renvoyée si la session utilisateur est vérifiée à l’aide d’un jeton d’API.
sessionid string Jeton d’authentification qui doit être utilisé dans les requêtes API suivantes.

La propriété sessionid n’est pas renvoyée si la session utilisateur est vérifiée à l’aide d’un jeton d’API.
type integer Type d’utilisateur.

Consultez la propriété type de l’objet Rôle pour obtenir la liste des valeurs possibles.
userip string Adresse IP de l’utilisateur.

Exemples

Vérifier l'authentification à l'aide du jeton d'authentification

Vérifiez et prolongez une session utilisateur à l'aide du jeton d'authentification de l'utilisateur, puis renvoyez des informations supplémentaires sur l'utilisateur.

Requête:

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

Réponse :

{
    "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
}
Vérifier l'authentification à l'aide d'un jeton API

Vérifiez une session utilisateur à l'aide du jeton API de l'utilisateur et renvoyez des informations supplémentaires sur l'utilisateur.

Requête:

{
    "jsonrpc": "2.0",
    "method": "user.checkAuthentication",
    "params": {
        "token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
    },
    "id": 1
}

Réponse :

{
    "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
}

Source

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