On this page
user.checkAuthentication
Apraksts
object user.checkAuthentication
Šī metode pārbauda un pagarina lietotāja sesiju.
Izsaucot metodi user.checkAuthentication, izmantojot parametru sessionid, lietotāja sesija pēc noklusējuma tiek pagarināta.
Parametri
Metode pieņem šādus parametrus.
| Parametrs | Tips | Apraksts |
|---|---|---|
| extend | boolean | Vai pagarināt lietotāja sesiju. Noklusējuma vērtība: "true". Ja vērtība ir iestatīta uz "false", ir iespējams pārbaudīt lietotāja sesiju, to nepagarinot. Parametra darbība: - atbalstīts, ja ir iestatīts sessionid |
| sessionid | string | Lietotāja autentifikācijas marķieris. Parametra darbība: - obligāts, ja token nav iestatīts |
| token | string | Lietotāja API marķieris. Parametra darbība: - obligāts, ja sessionid nav iestatīts |
Atgrieztās vērtības
(object) Atgriež objektu, kas satur informāciju par lietotāju.
Papildus standarta lietotāja īpašībām tiek atgriezta šāda informācija.
| Īpašība | Tips | Apraksts |
|---|---|---|
| auth_type | integer | Noklusējuma autentifikācija lietotājam. Iespējamo vērtību sarakstu skatiet Authentication object īpašībā authentication_type. |
| debug_mode | integer | Vai lietotājam ir iespējots vai atspējots atkļūdošanas režīms. Iespējamo vērtību sarakstu skatiet User group object īpašībā debug_mode. |
| deprovisioned | boolean | Vai lietotājs pieder deprovisioned users group. |
| gui_access | string | Lietotāja autentifikācijas metode lietotāja saskarnei. Iespējamo vērtību sarakstu skatiet User group object īpašībā gui_access. |
| secret | string | Nejauša 32 rakstzīmju virkne. Tiek ģenerēta lietotāja pieteikšanās laikā. Īpašība secret netiek atgriezta, ja lietotāja sesija tiek pārbaudīta, izmantojot API tokenu. |
| sessionid | string | Autentifikācijas tokens, kas jāizmanto turpmākajos API pieprasījumos. Īpašība sessionid netiek atgriezta, ja lietotāja sesija tiek pārbaudīta, izmantojot API tokenu. |
| type | integer | Lietotāja tips. Iespējamo vērtību sarakstu skatiet Role object īpašībā type. |
| userip | string | Lietotāja IP adrese. |
Piemēri
Pārbaudīt autentifikāciju, izmantojot autentifikācijas marķieri
Pārbaudiet un pagariniet lietotāja sesiju, izmantojot lietotāja autentifikācijas marķieri, un atgrieziet papildu informāciju par lietotāju.
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"sessionid": "673b8ba11562a35da902c66cf5c23fa2"
},
"id": 1
}Atbilde:
{
"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
}Pārbaudīt autentifikāciju, izmantojot API pilnvaru
Pārbaudiet lietotāja sesiju, izmantojot lietotāja API pilnvaru, un atgrieziet papildu informāciju par lietotāju.
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
},
"id": 1
}Atbilde:
{
"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
}Avots
CUser::checkAuthentication() failā ui/include/classes/api/services/CUser.php.