token.get

Beschreibung

integer/array token.get(object parameters)

Mit dieser Methode können Token entsprechend den angegebenen Parametern abgerufen werden.

Nur der Benutzertyp Super admin darf Token anderer Benutzer anzeigen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
tokenids ID/array Gibt nur Token mit den angegebenen IDs zurück.
userids ID/array Gibt nur Token zurück, die für die angegebenen Benutzer erstellt wurden.
token string Gibt nur Token zurück, die für das angegebene Auth token erstellt wurden.
valid_at timestamp Gibt nur Token zurück, die zum angegebenen Datum und zur angegebenen Uhrzeit gültig (nicht abgelaufen) sind.
expired_at timestamp Gibt nur Token zurück, die zum angegebenen Datum und zur angegebenen Uhrzeit abgelaufen (nicht gültig) sind.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: tokenid, name, lastaccess, status, expires_at, created_at.
countOutput boolean Diese Parameter werden im Referenzkommentar beschrieben.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Ein Token abrufen

Rufen Sie alle Daten für das Token mit der ID „2“ ab.

Anfrage:

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

Antwort:

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

Quelle

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