token.get
Описание
целое число/массив token.get(параметры объекта)
Этот метов позволяет получать токены в соответствии с заданными параметрами.
Только пользователю типа Super admin разрешено видеть токены других пользователей.
Параметры
(object) Параметры, определяющие желаемый вывод.
Метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| tokenids | ID/array | Возвращать только токены с указанными ID. |
| userids | ID/array | Возвращать только токены, созданные для указанных пользователей. |
| token | string | Возвращать только токены, созданные для указанного Auth token. |
| valid_at | timestamp | Возвращать только токены, которые действительны (не истекли) на указанные дату и время. |
| expired_at | timestamp | Возвращать только токены, срок действия которых истёк (они недействительны) на указанные дату и время. |
| sortfield | string/array | Сортировать результат по указанным свойствам. Возможные значения: tokenid, name, lastaccess, status, expires_at, created_at. |
| countOutput | boolean | Эти параметры описаны в справочном комментарии. |
| 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"
},
"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.