Documentation
Table of Contents
token.get
§°§á§Ú§ã§Ñ§ß§Ú§Ö
§è§Ö§Ý§à§Ö §é§Ú§ã§Ý§à/§Þ§Ñ§ã§ã§Ú§Ó token.get(§á§Ñ§â§Ñ§Þ§Ö§ä§â§í §à§Ò§ì§Ö§Ü§ä§Ñ)
§¿§ä§à§ä §Þ§Ö§ä§à§Ó §á§à§Ù§Ó§à§Ý§ñ§Ö§ä §á§à§Ý§å§é§Ñ§ä§î §ä§à§Ü§Ö§ß§í §Ó §ã§à§à§ä§Ó§Ö§ä§ã§ä§Ó§Ú§Ú §ã §Ù§Ñ§Õ§Ñ§ß§ß§í§Þ§Ú §á§Ñ§â§Ñ§Þ§Ö§ä§â§Ñ§Þ§Ú.
§´§à§Ý§î§Ü§à §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§ð §ä§Ú§á§Ñ Super admin §â§Ñ§Ù§â§Ö§ê§Ö§ß§à §Ó§Ú§Õ§Ö§ä§î §ä§à§Ü§Ö§ß§í §Õ§â§å§Ô§Ú§ç §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§Ö§Û.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| tokenids | string/array | Return only tokens with the given IDs. |
| userids | string/array | Return only tokens created for the given users. |
| token | string | Return only tokens created for the given Auth token. |
| valid_at | timestamp | Return only tokens which are valid (not expired) at the given date and time. |
| expired_at | timestamp | Return only tokens which are expired (not valid) at the given date and time. |
| sortfield | string/array | Sort the result by the given properties. Possible values are: tokenid, name, lastaccess, status, expires_at and created_at. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary. |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
§£§à§Ù§Ó§â§Ñ§ë§Ñ§Ö§Þ§í§Ö §Ù§ß§Ñ§é§Ö§ß§Ú§ñ
(§è§Ö§Ý§à§Ö §é§Ú§ã§Ý§à/§Þ§Ñ§ã§ã§Ú§Ó) §£§à§Ù§Ó§â§Ñ§ë§Ñ§Ö§ä §Ý§Ú§Ò§à:
- ¡¤ §Þ§Ñ§ã§ã§Ú§Ó §à§Ò§ì§Ö§Ü§ä§à§Ó;
- ¡¤ §Ü§à§Ý§Ú§é§Ö§ã§ä§Ó§à §Ú§Ù§Ó§Ý§Ö§é§Ö§ß§ß§í§ç §à§Ò§ì§Ö§Ü§ä§à§Ó, §Ö§ã§Ý§Ú §Ú§ã§á§à§Ý§î§Ù§à§Ó§Ñ§Ý§ã§ñ §á§Ñ§â§Ñ§Þ§Ö§ä§â
countOutput.
§±§â§Ú§Þ§Ö§â§í
§±§à§Ý§å§é§Ö§ß§Ú§Ö §ä§à§Ü§Ö§ß§Ñ
§±§à§Ý§å§é§Ú§ä§î §Ó§ã§Ö §Õ§Ñ§ß§ß§Ö §Õ§Ý§ñ §ä§à§Ü§Ö§ß§Ñ §ã ID "2".
§©§Ñ§á§â§à§ã:
{
"jsonrpc": "2.0",
"method": "token.get",
"params": {
"output": "extend",
"tokenids": "2"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}§°§ä§Ó§Ö§ä:
{
"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() §Ó ui/include/classes/api/services/CToken.php.