Token introspection endpoint

Devuelve validez y metadatos para acceder a tokens y actualizarlos.

POST /oauth/v3/token/introspect

Punto de terminación de la introspección de token

cURL

curl --request POST \
  --url https://api.hubapi.com/oauth/v3/token/introspect \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=<string>' \
  --data 'client_secret=<string>' \
  --data 'token=<string>' \
  --data 'token_type_hint=<string>'

import requests

url = "https://api.hubapi.com/oauth/v3/token/introspect"

payload = {
    "client_id": "<string>",
    "client_secret": "<string>",
    "token": "<string>",
    "token_type_hint": "<string>"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams({
    client_id: '<string>',
    client_secret: '<string>',
    token: '<string>',
    token_type_hint: '<string>'
  })
};

fetch('https://api.hubapi.com/oauth/v3/token/introspect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/oauth/v3/token/introspect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "client_id=%3Cstring%3E&client_secret=%3Cstring%3E&token=%3Cstring%3E&token_type_hint=%3Cstring%3E",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/oauth/v3/token/introspect"

	payload := strings.NewReader("client_id=%3Cstring%3E&client_secret=%3Cstring%3E&token=%3Cstring%3E&token_type_hint=%3Cstring%3E")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/oauth/v3/token/introspect")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("client_id=%3Cstring%3E&client_secret=%3Cstring%3E&token=%3Cstring%3E&token_type_hint=%3Cstring%3E")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/oauth/v3/token/introspect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "client_id=%3Cstring%3E&client_secret=%3Cstring%3E&token=%3Cstring%3E&token_type_hint=%3Cstring%3E"

response = http.request(request)
puts response.read_body

200

{
  "active": true,
  "app_id": 123,
  "client_id": "<string>",
  "expires_in": 123,
  "hub_id": 123,
  "is_private_distribution": true,
  "scopes": [
    "<string>"
  ],
  "signed_access_token": {
    "appId": 123,
    "appInstallId": "<string>",
    "audience": "<string>",
    "expiresAt": 123,
    "hubId": 123,
    "hublet": "<string>",
    "installingUserId": 123,
    "isPrivateDistribution": true,
    "isServiceAccount": true,
    "isUserLevel": true,
    "newSignature": "<string>",
    "scopeToScopeGroupPks": "<string>",
    "scopes": "<string>",
    "signature": "<string>",
    "trialScopeToScopeGroupPks": "<string>",
    "trialScopes": "<string>",
    "userId": 123
  },
  "token": "<string>",
  "token_type": "<string>",
  "token_use": "access_token",
  "user_id": 123,
  "hub_domain": "<string>",
  "user": "<string>"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Cuerpo

application/x-www-form-urlencoded

client_id · string

client_secret · string

token · string

token_type_hint · string

Respuesta

200

application/json

successful operation

Option 1

Option 2

active · boolean · requerido

app_id · integer<int32> · requerido

client_id · string · requerido

expires_in · integer<int64> · requerido

hub_id · integer<int32> · requerido

is_private_distribution · boolean · requerido

scopes · string[] · requerido

signed_access_token · object · requerido

Show child attributes

token · string · requerido

token_type · string · requerido

token_use · enum<string> · predeterminado: access_token · requerido

Opciones disponibles: access_token

user_id · integer<int32> · requerido

hub_domain · string

user · string