token.get

Beschrijving

integer/array token.get(objectparameters)

De methode maakt het mogelijk om tokens op te halen volgens de gegeven parameters.

Alleen het gebruikerstype Superbeheerder mag tokens bekijken voor andere gebruikers.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
tokenids	string/array	Retourneer alleen tokens met de opgegeven ID's.
userids	string/array	Retourneer alleen tokens die voor de opgegeven gebruikers zijn gemaakt.
token	string	Retourneer alleen tokens die zijn gemaakt voor het opgegeven Auth-token.
valid_at	timestamp	Retourneer alleen tokens die geldig (niet verlopen) zijn op de opgegeven datum en tijd.
expired_at	timestamp	Retourneer alleen tokens die zijn verlopen (niet geldig) op de opgegeven datum en tijd.
sortfield	string/array	Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: `tokenid`, `name`, `lastaccess`, `status`, `expires_at` en `created_at`.
countOutput	boolean	Deze parameters gelden voor alle `get`-methoden en worden in detail beschreven in de referentiecommentaar.
excludeSearch	boolean
filter	object
limiet	geheel getal
uitvoer	query
preservekeys	boolean
zoeken	object
searchByAny	boolean
searchWildcardsIngeschakeld	boolean
sortorde	string/array
startZoeken	booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Ophalen van een token

Haal alle gegevens op voor het token met ID "2".

Verzoek:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "tokenid": "1",
                   "name": "Het Token",
                   "description": "",
                   "userid": "1",
                   "lastaccess": "0",
                   "status": "0",
                   "expires_at": "1609406220",
                   "created_at": "1611239454",
                   "creator_userid": "1"
               }
           ],
           "id": 1
       }

Bron

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

Documentation