Documentation
Table of Contents
token.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array token.get(object parameters)
El m¨¦todo permite recuperar tokens seg¨²n los par¨¢metros dados.
S¨®lo el tipo de usuario Super administrador puede ver tokens para otros usuarios.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| tokenids | ID/array | Devuelve solo tokens con los ID proporcionados. |
| userids | ID/matriz | Devuelve solo tokens creados para los usuarios dados. |
| token | string | Devuelve solo los tokens creados para el token de autenticaci¨®n dado. |
| valid_at | timestamp | Devuelve solo tokens que sean v¨¢lidos (no vencidos) en la fecha y hora indicadas. |
| expired_at | marca de tiempo | Devuelve solo los tokens que est¨¦n vencidos (no son v¨¢lidos) en la fecha y hora indicadas. |
| sortfield | string/array | Ordena el resultado por las propiedades dadas. Valores posibles: tokenid, name, lastaccess, status, expires_at, created_at. |
| countOutput | boolean | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en detalle en el comentario de referencia. |
| excluirBuscar | booleano | |
| filtro | objeto | |
| ±ô¨ª³¾¾±³Ù±ð | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| ³¦±ô²¹²õ¾±´Ú¾±³¦²¹³¦¾±¨®²Ô | cadena/matriz | |
| iniciarBuscar | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el par¨¢metro
countOutputha sido usado.
Ejemplos
Recuperar un token
Recupere todos los datos del token con ID "2".
{
"jsonrpc": "2.0",
"method": "token.get",
"params": {
"output": "extend",
"tokenids": "2"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"tokenid": "1",
"name": "The Token",
"description": "",
"userid": "1",
"lastaccess": "0",
"status": "0",
"expires_at": "1609406220",
"created_at": "1611239454",
"creator_userid": "1"
}
],
"id": 1
}Fuente
CToken::get() en ui/include/classes/api/services/CToken.php.