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 suporta os seguintes parâmetros.

Parâmetro Tipo Descrição
tokenids ID/array Retorna apenas tokens com os IDs fornecidos.
userids ID/array Retorna apenas tokens criados para os usuários fornecidos.
token string Retorna apenas tokens criados para o Auth token fornecido.
valid_at timestamp Retorna apenas tokens que são válidos (não expirados) na data e hora fornecidas.
expired_at timestamp Retorna apenas tokens que estão expirados (não válidos) na data e hora fornecidas.
sortfield string/array Ordena o resultado pelas propriedades fornecidas.

Valores possíveis: tokenid, name, lastaccess, status, expires_at, created_at.
countOutput boolean Esses parâmetros são descritos 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 countOutput foi usado.

Exemplos

Recuperar um token

Recupere todos os dados do token com o ID "2".

Requisição:

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

Resposta:

{
    "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.