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

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

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
imageids cadena/matriz Devuelve solo imágenes con los IDs proporcionados.
sysmapids cadena/matriz Devuelve imágenes que se utilizan en los mapas dados.
select_image flag Devuelve una propiedad image con la imagen codificada en Base64.
sortfield cadena/matriz Ordena el resultado según las propiedades dadas.

Los valores posibles son: imageid y name.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el reference commentary.
editable booleano
excluirBuscar booleano
filtro objeto
límite número 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"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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.