审视访问令牌

检查访问令牌以查看其是否有效且处于活动状态。您还可以验证一些令牌属性，例如其声明、范围和有效时间。

对此端点的请求需要使用您的客户端 ID 和客户端密钥进行身份验证，使用以下方法之一*：*

基本访问认证（推荐）：对于基本访问认证，{credentials}字符串必须是的Base64编码值{client id}:{client secret}。

主体参数client_id：使用和client_secret主体参数提供您的集成凭据。

curl --location --request POST 'http://dev-cn.your-api-server.com/rest/v1/oauth/introspect' \ --header 'Authorization: Basic {credentials}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'token=JagALLazU0i2ld9WW4zTO4kaG0lkvP8Y5sSO206ZwxNF4E1y3xKJKF7TzN17BXTfaNOeY0P88AeRCE6cRF7SJzvf3Sx97rA80sGHtFplFo'

{ "active": true, "scope": "asset:read design:meta:read design:permission:read folder:read", "client": "OC-FAB12-AbCdEf", "exp": 1712216144, "iat": 1712201744, "nbf": 1712201744, "jti": "AbC1d-efgHIJKLMN2oPqrS", "sub": "oBCdEF1Gh2i3jkLmno-pq" }

请求参数

Header 参数

Authorization

string

可选

示例值:

Basic {credentials}

Content-Type

string

必需

示例值:

application/x-www-form-urlencoded

Body 参数application/x-www-form-urlencoded

token

string

要自省的令牌。

必需

示例值:

JagALLazU0i2ld9WW4zTO4kaG0lkvP8Y5sSO206ZwxNF4E1y3xKJKF7TzN17BXTfaNOeY0P88AeRCE6cRF7SJzvf3Sx97rA80sGHtFplFo

返回响应

🟢200成功

application/json

Body

active

boolean

必需

访问令牌是否有效。如果true，则访问令牌有效且处于活动状态。如果false，则访问令牌无效。

scope

string

已授予令牌的范围。

必需

client

string

必需

请求令牌的客户端的 ID。

exp

integer

必需

令牌的过期时间，以秒为单位的Unix 时间戳。

iat

integer

必需

令牌的颁发时间，以秒为单位的 Unix 时间戳。

nbf

integer

必需

令牌的“不早于”时间，指定在此时间之前访问令牌不被接受，以秒为单位的 Unix 时间戳。

jti

string

必需

访问令牌的唯一 ID。

sub

string

必需

声明的主题。这是访问令牌所代表的 Canva 用户的 ID。这是一个模糊值，因此单个用户在每个集成中都有一个唯一的 ID。如果同一个用户授权另一个集成，则他们在该集成中的 ID 会有所不同。