Documentation
Table of Contents
user.checkAuthentication
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
object user.checkAuthentication
Aquest m¨¨tode verifica i perllonga la sessi¨® d'usuari.
La crida al m¨¨tode user.checkAuthentication emprant el par¨¤metre establert sessionidperllonga per defecte la sessi¨® d'usuari.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
El m¨¨tode admet els par¨¤metres seg¨¹ents.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| extend | ²ú´Ç´Ç±ô±ð¨¤ | Si s'ha de perllongar la sessi¨® de l'usuari. Valor per defecte: "cert". Ajustar el valor a "fals" permet comprovar la sessi¨® de l'usuari sense allargar-la. <br >Comportament del par¨¤metre: - ²¹»å³¾¨¨²õ si sessionid ¨¦s establert |
| sessionid | cadena | Usuari token d'autenticaci¨®. Comportament del par¨¤metre: - 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. Comportament del par¨¤metre: - obligatori si sessionid no s'ha establert |
Valors de retorn
(objecte) Retorna un objecte que cont¨¦ informaci¨® sobre l'usuari.
A m¨¦s de les propietats d'usuari est¨¤ndard, retorna la informaci¨® seg¨¹ent.
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| auth_type | enter | ´¡³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨® per defecte per a l'usuari. Consulteu la propietat authentication_type de l'Objecte d'autenticaci¨® per a un llista de possibles valors. |
| debug_mode | enter | Si el mode de depuraci¨® est¨¤ activat o desactivat per a l'usuari. Consulteu la propietat debug_mode de l'Objecte del grup d'usuaris per obtindre una llista de possibles valors. |
| desprovisioned | ²ú´Ç´Ç±ô±ð¨¤ | Si l'usuari pertany a un grup d'usuaris desprovisionats. |
| gui_access | cadena | M¨¨tode d'autenticaci¨® de l'usuari a la interf¨ªcie. Consulteu la propietat gui_access del llistat de possibles valors de l'objecte del grup d'usuaris. |
| secret | cadena | Cadena aleat¨°ria de 32 car¨¤cters. Es genera a l'inici de sessi¨® de l'usuari. 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. La propietat sessionid no es retorna si la sessi¨® de l'usuari es verifica amb un token d'API. |
| type | enter | Tipus d'usuari. Consulteu la propietat type de l'objecte rol per obtindre una llista de valors possibles. |
| userip | cadena | Adre?a IP de l'usuari. |
Exemples
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.
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"sessionid": "673b8ba11562a35da902c66cf5c23fa2"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"username": "Admin",
"name": "Áú»¢¶Ä²©",
"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
}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.
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"username": "Admin",
"name": "Áú»¢¶Ä²©",
"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
}Font
CUser::checkAuthentication() a ui/include/classes/api/services/CUser.php.