请求令牌自省
通过用户 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 | 客户端ID | 否 | 2bae87d88feb129f817a1ce52d798e0b | 客户端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/#错误码"
}