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": {
      "description": "The token to introspect",
      "type": "string"
    },
    "client_id": {
      "description": "The application client ID",
      "$ref": "#/components/schemas/SnowflakeType"
    },
    "client_secret": {
      "description": "The application client secret",
      "type": "string"
    }
  },
  "required": [
    "token"
  ]
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean",
      "description": "Whether the token is currently active"
    },
    "scope": {
      "description": "The space-separated list of scopes",
      "type": "string"
    },
    "client_id": {
      "description": "The client identifier for the token",
      "$ref": "#/components/schemas/SnowflakeStringType"
    },
    "username": {
      "description": "The username of the token owner",
      "type": "string"
    },
    "token_type": {
      "description": "The type of token",
      "type": "string"
    },
    "exp": {
      "description": "The expiration timestamp in seconds",
      "$ref": "#/components/schemas/Int32Type"
    },
    "iat": {
      "description": "The issued-at timestamp in seconds",
      "$ref": "#/components/schemas/Int32Type"
    },
    "sub": {
      "description": "The subject identifier (user ID)",
      "$ref": "#/components/schemas/SnowflakeStringType"
    }
  },
  "required": [
    "active"
  ],
  "additionalProperties": false
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}