post/oauth2/introspect

Introspect OAuth2 token

Verifies token validity and retrieves metadata. Returns active status, scope, expiration, and user information. Client authentication via authorization header or client credentials.

introspect_oauth2_token

Request body

multipart/form-data

json

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "The token to introspect"
    },
    "client_id": {
      "$ref": "#/components/schemas/SnowflakeType"
    },
    "client_secret": {
      "type": "string",
      "description": "The application client secret"
    }
  },
  "required": [
    "token"
  ]
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean",
      "description": "Whether the token is currently active"
    },
    "scope": {
      "type": "string",
      "description": "The space-separated list of scopes"
    },
    "client_id": {
      "$ref": "#/components/schemas/SnowflakeType"
    },
    "username": {
      "type": "string",
      "description": "The username of the token owner"
    },
    "token_type": {
      "type": "string",
      "description": "The type of token"
    },
    "exp": {
      "$ref": "#/components/schemas/Int32Type"
    },
    "iat": {
      "$ref": "#/components/schemas/Int32Type"
    },
    "sub": {
      "$ref": "#/components/schemas/SnowflakeType"
    }
  },
  "required": [
    "active"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}