token.get

Descrizione

integer/array token.get(object parameters)

Questo metodo consente di recuperare i token in base ai parametri specificati.

Solo il tipo di utente Super admin può visualizzare i token di altri utenti.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Type Descrizione
tokenids ID/array Restituisce solo i token con gli ID specificati.
userids ID/array Restituisce solo i token creati per gli utenti specificati.
token string Restituisce solo i token creati per il token di autenticazione specificato.
valid_at timestamp Restituisce solo i token che sono validi (non scaduti) alla data e ora specificate.
expired_at timestamp Restituisce solo i token che sono scaduti (non validi) alla data e ora specificate.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: tokenid, name, lastaccess, status, expires_at, created_at.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce o:

  • una matrice di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput è stato usato.

Esempi

Recuperare un token

Recupera tutti i dati del token con ID "2".

Richiesta:

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

Risposta:

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