跳到主要内容
在线体验
微信咨询
获取方案

请求令牌自省

通过用户 token 获取账户信息。

请求说明

请求方式:POST

请求地址https://{your_domain}/api/v1/authorize/{app_code}/oauth2/introspect

请求头

参数名中文名称必须示例值描述
Authorization认证信息Basic MTk4MzhkOTc0ZTM=使用client_id和client_secret进行basic64认证,格式为: base64(client_id:client_secret)。

请求示例

POST https://{your_domain}/api/v1/authorize/{app_code}/oauth2/introspect
Authorization: Bearer eyJraWQiOiIxMTI5MDE5ifQ...
?token=LGNP5bRKmuiIhmJPDkuGnx...&token_type_hint=refresh_token

请求参数

参数名中文名称必须示例值描述
token令牌LGNP5bRKmuiIhmJPDkuGnx...令牌,根据token_type_hint类型传递。
token_type_hint令牌类型refresh_token令牌类型,可选值:access_token、refresh_token。

响应参数

参数名中文名称必须示例值描述
active是否有效true令牌在当前时间点上是否有效。
client_id客户端ID2bae87d88feb129f817a1ce52d798e0b客户端id。
iat颁发时间1702127995自 Unix 纪元(1970年1月1日)以来的秒数。
exp过期时间1704719995自 Unix 纪元(1970年1月1日)以来的秒数。

响应示例

成功

{
"active": true,
"client_id": "2bae87d88feb129f817a1ce52d798e0b",
"iat": 1702127995,
"exp": 1704719995
}

token 未传递

{
"error_description": "OAuth 2.0 Token Introspection Parameter: token",
"error": "invalid_request",
"error_uri": "https://topiam.cn/docs/application/oidc/faq/#%E9%94%99%E8%AF%AF%E7%A0%81"
}

客户端未认证

{
"error_description": "Full authentication is required to access this resource",
"error": "access_denied",
"error_uri": "https://topiam.cn/docs/application/oidc/faq/#错误码"
}

client_id 或 client_secret 错误

{
"error_description": "Client authentication failed. Either the client or the client credentials are invalid.",
"error": "invalid_client",
"error_uri": "https://topiam.cn/docs/application/oidc/faq/#错误码"
}