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	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
límite	entero
salida	consulta
preservekeys	booleano
buscar	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
clasificación	cadena/matriz
iniciarBuscar	booleano

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar un token

Recupere todos los datos del token con ID "2".

Solicitud:

{
           "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.

Documentation