integer/array token.get(object parameters)
该方法允许根据给定的参数检索令牌。
只有超级管理员用户类型可以查看其他用户的令牌。
(object)
定义所需输出的参数。
该方法支持以下参数。
参数 | 数据类型 | 描述 |
---|---|---|
tokenids | ID/array | 仅返回具有指定ID的令牌。 |
userids | ID/array | 仅返回为指定用户创建的令牌。 |
token | string | 仅返回为指定 认证令牌 创建的令牌。 |
valid_at | timestamp | 仅返回在指定日期和时间仍然有效(未过期)的令牌。 |
expired_at | timestamp | 仅返回在指定日期和时间已过期(无效)的令牌。 |
sortfield | string/array | 按照指定属性对结果进行排序。 可能的值: tokenid 、name 、lastaccess 、status 、expires_at 、created_at 。 |
countOutput | boolean | 这些参数在 通用get方法参数 中有描述。 |
excludeSearch | boolean | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | boolean | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | boolean |
(integer/array)
返回以下之一:
countOutput
参数,则为检索到的 objects 的数量。检索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
}
ui/include/classes/api/services/CToken.php 中的 CToken::get()。