[comment]: # translation:outdated

[comment]: # ({43f8bc43-43f8bc43})
# user.checkAuthentication

[comment]: # ({/43f8bc43-43f8bc43})

[comment]: # ({3c28b1f2-a9b9d697})
### Descripció

`object user.checkAuthentication`

Aquest mètode verifica i perllonga la sessió d'usuari.

::: noteimportant
La crida al mètode `user.checkAuthentication` emprant el paràmetre establert `sessionid`perllonga per defecte la sessió d'usuari.
:::

[comment]: # ({/3c28b1f2-a9b9d697})

[comment]: # ({340bc2e8-49a0b391})
### Paràmetres

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|extend|booleà|Si s'ha de perllongar la sessió de l'usuari.<br><br>Valor per defecte: "cert".<br>Ajustar el valor a "fals" permet comprovar la sessió de l'usuari sense allargar-la.<br><br >[Comportament del paràmetre](/manual/api/reference_commentary#parameter-behavior):<br>- *admès* si `sessionid` és establert|
|sessionid|cadena|Usuari [token d'autenticació](/manual/api#authentication).<br><br>[Comportament del paràmetre](/manual/api/reference_commentary#parameter-behavior):<br>- *obligatori* si `token` no s'ha establert|
|secret|cadena|Cadena aleatòria de 32 caràcters. Es genera a l'inici de sessió de l'usuari.|
|token|cadena|Usuari [token API](/manual/api#authentication).<br><br>[Comportament del paràmetre](/manual/api/reference_commentary#parameter-behavior):<br>- *obligatori* si `sessionid` no s'ha establert|

[comment]: # ({/340bc2e8-49a0b391})

[comment]: # ({0df38ffd-a8544e3e})
### Valors de retorn

`(objecte)` Retorna un objecte que conté informació sobre l'usuari.

A més de les [propietats d'usuari estàndard](objecte#usuari), retorna la informació següent.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|auth\_type|enter|Autenticació per defecte per a l'usuari.<br><br>Consulteu la propietat `authentication_type` de l'[Objecte d'autenticació](/manual/api/reference/authentication/object#authentication-object) per a un llista de possibles valors.|
|debug\_mode|enter|Si el mode de depuració està activat o desactivat per a l'usuari.<br><br>Consulteu la propietat `debug_mode` de l'[Objecte del grup d'usuaris](/manual/api/reference/usergroup/object# user_group) per obtindre una llista de possibles valors.|
|desprovisioned|booleà|Si l'usuari pertany a un [grup d'usuaris desprovisionats](/manual/web_interface/frontend_sections/users/authentication#configuration).|
|gui\_access|cadena|Mètode d'autenticació de l'usuari a la interfície.<br><br>Consulteu la propietat `gui_access` del llistat de possibles valors de l'[objecte del grup d'usuaris](/manual/api/reference/usergroup/object#user_group).|
|secret|cadena|Cadena aleatòria de 32 caràcters. Es genera a l'inici de sessió de l'usuari.<br><br>La propietat `secret` no es retorna si la sessió de l'usuari es verifica amb un token API.|
|sessionid|cadena|Fitxa d'autenticació, que s'ha d'emprar a les peticions d'API següents.<br><br>La propietat `sessionid` no es retorna si la sessió de l'usuari es verifica amb un token d'API.|
|type|enter|Tipus d'usuari.<br><br>Consulteu la propietat `type` de l'[objecte rol](/manual/api/reference/role/object#role) per obtindre una llista de valors possibles.|
|userip|cadena|Adreça IP de l'usuari.|

[comment]: # ({/0df38ffd-a8544e3e})

[comment]: # ({b41637d2-e79e2236})
### Exemples

[comment]: # ({/b41637d2-e79e2236})

[comment]: # ({ed94544a-d574e685})
##### Comprovar l'autenticació emprant un token d'autenticació

Comproveu i allargueu una sessió d'usuari mitjançant el token d'autenticació d'usuari i retorneu informació addicional sobre l'usuari.

[Petició](/manual/api#performing-requests):

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

Resposta:

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

[comment]: # ({/ed94544a-d574e685})

[comment]: # ({4b3db63b-698590d0})
##### Comprovar l'autenticació mitjançant el token API

Comproveu una sessió d'usuari mitjançant el token de l'API d'usuari i retorneu informació addicional sobre l'usuari.

[Petició](/manual/api#performing-requests):

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

Resposta:

```json
{
    "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",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "1",
        "deprovisioned": false,
        "auth_type": 0
    },
    "id": 1
}
```

[comment]: # ({/4b3db63b-698590d0})

[comment]: # ({e7148ebe-97f5ed87})
### Font

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

[comment]: # ({/e7148ebe-97f5ed87})