Table of Contents
token.get
Descri??o
integer/array token.get(object parameters)
O m¨¦todo permite recuperar tokens de acordo com os par?metros fornecidos.
Apenas o tipo de usu¨¢rio Super admin tem permiss?o para visualizar tokens para outros usu¨¢rios.
Par?metros
(object) Par?metros que definem a sa¨ªda desejada.
O m¨¦todo oferece suporte aos par?metros a seguir.
| Par?metro | Type | 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. 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. |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o par?metro
countOutputfoi usado.
Exemplos
Recuperar um token
Recupere todos os dados do token com ID "2".
Request:
{
"jsonrpc": "2.0",
"method": "token.get",
"params": {
"output": "extend",
"tokenids": "2"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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
}Fonte
CToken::get() in ui/include/classes/api/services/CToken.php.