token.get

Descripción

integer/array token.get(object parameters)

El método permite recuperar tokens según los parámetros dados.

Solo el tipo de usuario Super admin puede ver los tokens de otros usuarios.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
tokenids	ID/array	Devolver solo los tokens con los IDs dados.
userids	ID/array	Devolver solo los tokens creados para los usuarios dados.
token	string	Devolver solo los tokens creados para el Auth token dado.
valid_at	timestamp	Devolver solo los tokens que sean válidos (no expirados) en la fecha y hora dadas.
expired_at	timestamp	Devolver solo los tokens que estén expirados (no válidos) en la fecha y hora dadas.
sortfield	string/array	Ordenar el resultado por las propiedades dadas. Valores posibles: `tokenid`, `name`, `lastaccess`, `status`, `expires_at`, `created_at`.
countOutput	boolean	Estos parámetros se describen en el comentario de referencia.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores de retorno

(entero/array) Devuelve:

un array de objetos;
el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar un token

Recuperar 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