token.get

Descripció

integer/array token.get(object parameters)

El mètode permet recuperar tokens segons els paràmetres donats.

Només el tipus d'usuari Super admin té permisos per veure els tokens d'altres usuaris.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
tokenids ID/array Retorna només tokens amb els ID donats.
userids ID/array Retorna només els tokens creats per als usuaris donats.
token string Retorna només els tokens creats per al token d'autenticació donat.
valid_at timestamp Retorna només tokens vàlids (no caducats) a la data i hora indicades.
expired_at timestamp Retorna només els tokens que han caducat (no vàlids) a la data i hora donades.
sortfield string/array Ordena el resultat segons les propietats donades.

Els valors possibles són: tokenid, name, lastaccess, status, expires_at i created_at.
countOutput boolean Aquests paràmetres comuns a tots els mètodes get es descriuen en detall a la pàgina comentaris de referència.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar un token

Recuperar tota la informació del token amb ID "2".

Petició:

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

Font

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