Documentation
Table of Contents
user.checkAuthentication
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
object user.checkAuthentication
Este m¨¦todo comprueba y prolonga la sesi¨®n del usuario.
Llamar al m¨¦todo user.checkAuthentication usando el par¨¢metro sessionid prolonga la sesi¨®n del usuario de forma predeterminada.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
El m¨¦todo acepta los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| extend | booleano | Si se debe prolongar la sesi¨®n del usuario. Valor predeterminado: "verdadero". Establecer el valor en "falso" permite verificar la sesi¨®n del usuario sin prolongarla. <br >Comportamiento de par¨¢metros: - compatible si se establece sessionid |
| sessionid | cadena | Token de autenticaci¨®n del usuario. Comportamiento de par¨¢metros: - obligatorio si token no est¨¢ configurado |
| secret | cadena | Cadena aleatoria de 32 caracteres. Se genera al iniciar sesi¨®n el usuario. |
| token | cadena | Token de API del usuario. Comportamiento de par¨¢metros: - obligatorio si sessionid no est¨¢ configurado |
Valores de retorno
(objeto) Devuelve un objeto que contiene informaci¨®n sobre el usuario.
Adem¨¢s de las propiedades est¨¢ndar de [usuario] (object#user), se devuelve la siguiente informaci¨®n.
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| auth_type | entero | ´¡³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô predeterminada para el usuario. Consulte la propiedad authentication_type del objeto de autenticaci¨®n para obtener una lista de valores posibles. |
| debug_mode | entero | Si el modo de depuraci¨®n est¨¢ habilitado o deshabilitado para el usuario. Consulte la propiedad debug_mode del objeto de grupo de usuarios para obtener una lista de valores posibles. |
| deprovisioned | booleano | Si el usuario pertenece a un grupo de usuarios desaprovisionados. |
| gui_access | stringcadenaM¨¦todo de autenticaci¨®n del usuario en la interfaz de usuario. Consulte la propiedad gui_access del objeto de grupo de usuarios para obtener un lista de valores posibles. |
|
| secret | cadena | Cadena aleatoria de 32 caracteres. Se genera al iniciar sesi¨®n el usuario. La propiedad secret no se devuelve si la sesi¨®n del usuario se verifica mediante un token API. |
| sessionid | cadena | Token de autenticaci¨®n, que debe usarse en las siguientes solicitudes API. La propiedad sessionid no se devuelve si la sesi¨®n del usuario se verifica usando un token API. |
| type | enterio | Tipo de usuario. Consulte la propiedad type del objeto de rol para obtener una lista de valores posibles. |
| userip | cadena | Direcci¨®n IP del usuario. |
Ejemplos
Verificar la autenticaci¨®n mediante el token de autenticaci¨®n
Verifique y prolongue la sesi¨®n de un usuario utilizando el token de autenticaci¨®n de usuario y devuelva informaci¨®n adicional sobre el usuario.
{
"jsonrpc": "2.0",
&±ç³Ü´Ç³Ù;³¾¨¦³Ù´Ç»å´Ç&±ç³Ü´Ç³Ù;: "user.checkAuthentication",
&±ç³Ü´Ç³Ù;±è²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ&±ç³Ü´Ç³Ù;: {
"sessionid": "673b8ba11562a35da902c66cf5c23fa2"
},
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}Respuesta:
{
"jsonrpc": "2.0",
"resultado": {
"ID de usuario": "1",
"nombre de usuario": "Administrador",
"nombre": "Áú»¢¶Ä²©",
"apellido": "Administrador",
"URL": "",
"autologin": "1",
"cierre de sesi¨®n autom¨¢tico": "0",
"lang": "ru_RU",
"actualizar": "0",
"tema": "predeterminado",
"intento_fallido": "0",
"intento_ip": "127.0.0.1",
"intento_reloj": "1355919038",
"rows_per_page": "50",
"timezone": "Europa/Riga",
"roleid": "3",
"userdirectoryid": "0",
"ts_provisioned": "0",
"tipo": 3,
"userip": "127.0.0.1",
&±ç³Ü´Ç³Ù;³¾´Ç»å´Ç³å»å±ð±è³Ü°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 0,
"gui_access": "0",
"desaprovisionado": falso,
&±ç³Ü´Ç³Ù;³Ù¾±±è´Ç³å²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 0,
"sessionid": "673b8ba11562a35da902c66cf5c23fa2",
"secreto": "0e329b933e46984e49a5c1051ecd0751"
},
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}Verificar la autenticaci¨®n mediante el token API
Verifique una sesi¨®n de usuario utilizando el token API de usuario y devuelva informaci¨®n adicional sobre el usuario.
{
"jsonrpc": "2.0",
&±ç³Ü´Ç³Ù;³¾¨¦³Ù´Ç»å´Ç&±ç³Ü´Ç³Ù;: "user.checkAuthentication",
&±ç³Ü´Ç³Ù;±è²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ&±ç³Ü´Ç³Ù;: {
"token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
},
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}Respuesta:
{
"jsonrpc": "2.0",
"resultado": {
"ID de usuario": "1",
"nombre de usuario": "Administrador",
"nombre": "Áú»¢¶Ä²©",
"apellido": "Administrador",
"URL": "",
"autologin": "1",
"cierre de sesi¨®n autom¨¢tico": "0",
"lang": "ru_RU",
"actualizar": "0",
"tema": "predeterminado",
"intento_fallido": "0",
"intento_ip": "127.0.0.1",
"intento_reloj": "1355919338",
"rows_per_page": "50",
"timezone": "Europa/Riga",
"roleid": "3",
"userdirectoryid": "0",
"ts_provisioned": "0",
"tipo": 3,
"userip": "127.0.0.1",
&±ç³Ü´Ç³Ù;³¾´Ç»å´Ç³å»å±ð±è³Ü°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 0,
"gui_access": "1",
"desaprovisionado": falso,
&±ç³Ü´Ç³Ù;³Ù¾±±è´Ç³å²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 0
},
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}Fuente
CUser::checkAuthentication() en ui/include/classes/api/services/CUser.php.