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	Alleen tokens met de opgegeven ID's retourneren.
userids	string/array	Alleen tokens retourneren die zijn aangemaakt voor de opgegeven gebruikers.
token	string	Alleen tokens retourneren die zijn aangemaakt voor de opgegeven Authenticatie-token.
valid_at	timestamp	Alleen tokens retourneren die geldig zijn (niet verlopen) op de opgegeven datum en tijd.
expired_at	timestamp	Alleen tokens retourneren die zijn verlopen (niet geldig) op de opgegeven datum en tijd.
sortfield	string/array	De resultaten sorteren op de opgegeven eigenschappen. Mogelijke waarden: `tokenid`, `name`, `lastaccess`, `status`, `expires_at`, `created_at`.
countOutput	boolean	Deze parameters, die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven in de referentietoelichting.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Een token ophalen

Alle gegevens ophalen voor het token met ID "2".

Request:

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

Antwoord:

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