检查Token有效性
检查当前用户的token是否有效,若token有效,则返回true;若无效或者token已过期,则返回false。
请求说明
http
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 | 使用表单方式提交参数 |
请求示例
http
POST https://{your_domain}/api/v1/oauth2/introspectAuthorization: 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
json
{
"active": true,
"token_type": "bearer",
"scope": "openid profile",
"client_id": "J8NFmU4tJVgDxKaJFmXTWvaHO",
"username": "zhangsan",
"exp": 1437275311
}当token无效或者过期时,正确返回示例
HTTP/1.1 200 OK
json
{
"active": false,
}错误示例
HTTP 401 Unauthorized
json
{
"error": "invalid_client",
"error_description": "Bad client credentials"
}返回参数
如果成功返回,即可在返回信息中获取到Access Token。
| 参数名 | 中文名称 | 必填 | 描述 |
|---|---|---|---|
| active | 令牌状态 | 必须 | true标识token有效 false表示token无效或过期 |
| token_type | 令牌类型 | 可选 | |
| scope | 授权范围 | 可选 | |
| client_id | 应用客户端ID | 可选 | |
| username | 用户名 | 可选 | |
| exp | 失效时间 | 可选 | Unix时间戳 |