Documentation
Table of Contents
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
countOutputzosta? 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
}?°ù¨®»å?´Ç
CToken::get() w ui/include/classes/api/services/CToken.php.