token.get

Opis

integer/array token.get(object parameters)

Ta metoda umożliwia pobieranie tokenów zgodnie z podanymi parametrami.

Tylko użytkownik typu Super admin może wyświetlać tokeny innych użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
tokenids ID/array Zwracaj tylko tokeny o podanych identyfikatorach.
userids ID/array Zwracaj tylko tokeny utworzone dla podanych użytkowników.
token string Zwracaj tylko tokeny utworzone dla podanego tokenu uwierzytelniającego.
valid_at timestamp Zwracaj tylko tokeny, które są ważne (nie wygasły) w podanej dacie i czasie.
expired_at timestamp Zwracaj tylko tokeny, które są wygasłe (nieważne) w podanej dacie i czasie.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości: tokenid, name, lastaccess, status, expires_at, created_at.
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie tokena

Pobierz wszystkie dane tokena o ID „2”.

Żądanie:

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

Odpowiedź:

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

Źródło

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