检查Token有效性

检查当前用户的token是否有效,若token有效,则返回true;若无效或者token已过期,则返回false。

# 请求说明

POST https://{your_domain}/api/v1/oauth2/introspect

# 请求头

参数名 中文名称 必须 示例值 描述
Authorization 认证信息 必须 Basic UnFCMkOWk9xWA== 使用client_id和client_secret进行basic64认证,
格式为: base64(client_id:client_secret)
Content-Type 数据类型 必须 application/x-www-form-urlencoded 使用表单方式提交参数

# 请求示例

POST https://{your_domain}/api/v1/oauth2/introspect

Authorization: Basic UnFCMkhKdGt6bFU...aT0NObkk4NlNOWk9xWA==

Content-Type: application/x-www-form-urlencoded

token=MmVkMTIyNGUzODBkYjY3UV4nmxKh4z....&token_type_hint=access_token

# 请求参数

参数名 中文名称 必须 示例值 描述
token 令牌
token_type_hint 可选 默认为 access_token

# 返回示例

当token有效时,正确返回示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
	"active": true,
    "token_type": "bearer",
 	"scope": "openid profile",
	"client_id": "J8NFmU4tJVgDxKaJFmXTWvaHO",
	"username": "zhangsan",
	"exp": 1437275311
}

当token无效或者过期时,正确返回示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
	"active": false,
}

错误返回示例
HTTP 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{ 	
    "error": "invalid_client",    
    "error_description": "Bad client credentials"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 返回参数

如果成功返回,即可在返回信息中获取到Access Token。

参数名 中文名称 必须 描述
active 令牌状态 必须 true标识token有效 false表示token无效或过期
token_type 令牌类型 可选
scope 授权范围 可选
client_id 应用客户端ID 可选
username 用户名 可选
exp 失效时间 可选 Unix时间戳