获取
描述
integer/array token.get(object parameters)
此方法允许根据给定的参数获取令牌。
只允许 Super admin(超级管理员) 用户可以查看其他用户的令牌。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| tokenids | ID/数组 | 仅返回具有给定ID的令牌。 |
| userids | ID/数组 | 仅返回为给定用户创建的令牌。 |
| token | 字符串 | 仅返回为给定 认证令牌 创建的令牌。 |
| valid_at | 时间戳 | 仅返回在给定日期和时间有效的（未过期）令牌。 |
| expired_at | 时间戳 | 仅返回在给定日期和时间已过期（无效）的令牌。 |
| sortfield | 字符串/数组 | 根据给定属性对结果进行排序。 可能的值： tokenid，name，lastaccess，status，expires_at，created_at。 |
| countOutput | 布尔值 | 这些参数在 参考说明 中描述。 |
| excludeSearch | 布尔值 | |
| filter | 对象 | |
| limit | 整数 | |
| output | 查询 | |
| preservekeys | 布尔值 | |
| search | 对象 | |
| searchByAny | 布尔值 | |
| searchWildcardsEnabled | 布尔值 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔值 |
返回值
(integer/array) 返回其中之一：
对象数组；
如果使用了 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
}来源
ui/include/classes/api/services/CToken.php 中的 CToken::get()。