跳到主要内容

验证token

GET 
/auth/v1/token/introspect

接口说明​

验证token是否有效，如果token有效，会返回token对应的sub值

入参要求：​

  • Authorization: 当前登录用户的access_token（必填，请求头中传入，格式为Bearer xxx）
  • client_id: 应用对应的客户端id（可选，默认为环境id）
  • x-device-id: 设备id（可选，当前登录设备的id）

前置条件：​

  • 需要有效的access_token
  • token未过期且未被撤销

出参：​

  • 如果token有效，返回token信息（token_type、client_id、sub、scope等）
  • 如果token无效，返回空对象

验证token请求示例​

GET /auth/v1/token/introspect
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ
x-device-id: device_123456

验证token响应示例（token有效）​

{
  "token_type": "Bearer",
  "client_id": "demo-app-2f8a9c3e1b4d",
  "sub": "9876543210123456789",
  "scope": "user sso"
}

验证token响应示例（token无效）​

{}

使用场景：​

  • 客户端需要验证token是否仍然有效
  • 在敏感操作前进行token有效性检查
  • 实现token自动刷新机制时验证当前token状态

注意事项：​

  • 此接口不会刷新token，只验证当前token的有效性
  • 如果token过期或已被撤销，会返回空对象
  • 建议在客户端实现token自动刷新机制，避免频繁调用此接口

Request​

Query Parameters

    client_id string

    应用对应的客户端id，可从云开发平台-->身份认证-->开发设置获取。默认为环境id，可以不传

Header Parameters

    x-device-id string

    设备id，当前登录设备的id。客户端应随机生成，并缓存到客户端。此参数与登录账号数有关

    Authorization stringrequired

    用户的access_token, 值的格式为Bearer xxx

    Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ

Body

    any

Responses​

A successful response.

Response Headers
    Schema
      token_type string

      令牌类型

      client_id string

      令牌所属应用的客户端ID

      sub string

      令牌所属用户的ID

      scope string

      令牌所允许的范围

    Loading...