Áú»¢¶Ä²©

token.get

¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®

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.

±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ

(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que defineixen la sortida esperada.

El m¨¨tode admet els par¨¤metres seg¨¹ents.

±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð Tipus ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
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 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".

±Ê±ð³Ù¾±³¦¾±¨®:

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