[comment]: # translation:outdated

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

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

[comment]: # ({980bb7e6-980bb7e6})
### Descrição  
  
`integer/array token.get(object parameters)`  
  
O método permite recuperar tokens de acordo com os parâmetros fornecidos.  
  
::: noteclassic  
Apenas o tipo de usuário *Super admin* tem permissão para visualizar tokens para outros usuários.
:::

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

[comment]: # ({02630552-cc094e72})
### Parâmetros  
  
`(object)` Parâmetros que definem a saída desejada.  
  
O método oferece suporte aos parâmetros a seguir.  
  
|Parâmetro|[Type](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|tokenids|string/array|Retorna apenas tokens com os IDs fornecidos.|  
|userids|string/array|Retorna apenas os tokens criados para os usuários fornecidos.|
|token|string|Retorna apenas os tokens criados para o *token de autenticação* fornecido.|  
|valid\_at|timestamp|Retorna apenas tokens válidos (não expirados) na data e hora especificadas.|
|expired\_at|timestamp|Retorna apenas os tokens que expiraram (não são válidos) na data e hora especificadas.|  
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `tokenid`, `name`, `lastaccess`, `status`, `expires_at` e `created_at`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes no [comentário de referência](/manual/api/reference_commentary#common_get_method_parameters).|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

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

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno  
  
`(integer/array)` Retorna:  
  
- uma matriz de objetos;  
- a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

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

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

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

[comment]: # ({9c4c4600-66760f5f})
#### Recuperar um token  
  
Recupere todos os dados do token com ID "2".

Request:

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

Response:

```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]: # ({/9c4c4600-66760f5f})

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

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

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