token.get

描述

integer/array token.get(object parameters)

该方法允许根据给定参数检索令牌。

超级管理员用户类型被允许查看其他用户的令牌。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数 数据类型 描述
tokenids string/array 仅返回具有指定ID的令牌。
userids string/array 仅返回为指定用户创建的令牌。
token string 仅返回为指定认证令牌创建的令牌。
valid_at timestamp 仅返回在指定日期和时间有效的(未过期的)令牌。
expired_at timestamp 仅返回在指定日期和时间已过期的(无效的)令牌。
sortfield string/array 按指定属性对结果进行排序。

可能的值为:tokenid, name, lastaccess, status, expires_atcreated_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) 返回以下两种情况之一:

  • 一个包含array的objects数组
  • 检索到的objects数量(当使用了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 文件中。