token.get

Opis

integer/array token.get(object parameters)

Ta metoda pozwala na pobranie tokenów zgodnie z podanymi parametrami.

Tylko użytkownik typu Super admin ma uprawnienia do przeglądania tokenów innych użytkowników.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr	Typ	Opis
tokenids	string/array	Zwraca tylko tokeny o podanych identyfikatorach.
userids	string/array	Zwraca tylko tokeny utworzone dla podanych użytkowników.
token	string	Zwraca tylko tokeny utworzone dla podanego Auth token.
valid_at	timestamp	Zwraca tylko tokeny, które są ważne (nie wygasły) w podanej dacie i godzinie.
expired_at	timestamp	Zwraca tylko tokeny, które wygasły (nie są ważne) w podanej dacie i godzinie.
sortfield	string/array	Sortuje wynik według podanych właściwości. Możliwe wartości to: `tokenid`, `name`, `lastaccess`, `status`, `expires_at` oraz `created_at`.
countOutput	boolean	Te parametry wspólne dla wszystkich metod `get` są opisane szczegółowo 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 jedną z opcji:

tablicę obiektów;
liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobierz token

Pobierz wszystkie dane dla tokena o ID "2".

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "token.get",
           "params": {
               "output": "extend",
               "tokenids": "2"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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.

Documentation