Documentation
Table of Contents
token.get
Descripción
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.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| tokenids | cadena/matriz | Devuelve solo tokens con los ID proporcionados. |
| userids | cadena/matriz | Devuelve solo tokens creados para los usuarios dados. |
| token | cadena | Devuelve solo los tokens creados para el token de autenticación dado. |
| valid_at | marca de tiempo | 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 | cadena/matriz | Ordena el resultado por las propiedades dadas. Valores posibles: tokenid, name, lastaccess, status, expires_at, created_at. |
| countOutput | booleano | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia. |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | 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.