[comment]: # ({d632e1b8-d632e1b8})
# token.get

[comment]: # ({/d632e1b8-d632e1b8})

[comment]: # ({980bb7e6-980bb7e6})
### Descripción

`integer/array token.get(object parameters)`

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

::: noteclassic
Sólo el tipo de usuario *Super administrador* puede ver tokens para
otros usuarios.
:::

[comment]: # ({/980bb7e6-980bb7e6})

[comment]: # ({bd09fafb-cc094e72})
### Parámetros

`(objeto)` Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|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.<br><br>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](/manual/api/reference_commentary#common_get_method_parameters).|
|excludeSearch|booleano|^|
|filter|objeto|^|
|limit|entero|^|
|output|consulta|^|
|preservekeys|booleano|^|
|search|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|sortorder|cadena/matriz|^|
|startSearch|booleano|^|

[comment]: # ({/bd09fafb-cc094e72})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(entero/matriz)` Devuelve:

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Ejemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({f8520490-66760f5f})
#### Recuperar un token

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

[Solicitud](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "token.get",
    "params": {
        "output": "extend",
        "tokenids": "2"
    },
    "id": 1
}
```

Respuesta:

```json
{
    "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
}
```

[comment]: # ({/f8520490-66760f5f})

[comment]: # ({5cf2ab45-5cf2ab45})
### Fuente

CToken::get() en *ui/include/classes/api/services/CToken.php*.

[comment]: # ({/5cf2ab45-5cf2ab45})