Introspect a token
curl --request POST \
--url https://api.hq.zone/v1/oauth/introspect \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "<string>",
"token": "<string>",
"client_secret": "<string>",
"token_type_hint": "<string>"
}
'import requests
url = "https://api.hq.zone/v1/oauth/introspect"
payload = {
"client_id": "<string>",
"token": "<string>",
"client_secret": "<string>",
"token_type_hint": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '<string>',
token: '<string>',
client_secret: '<string>',
token_type_hint: '<string>'
})
};
fetch('https://api.hq.zone/v1/oauth/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.hq.zone/v1/oauth/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 => json_encode([
'client_id' => '<string>',
'token' => '<string>',
'client_secret' => '<string>',
'token_type_hint' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.hq.zone/v1/oauth/introspect"
payload := strings.NewReader("{\n \"client_id\": \"<string>\",\n \"token\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"token_type_hint\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
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.hq.zone/v1/oauth/introspect")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"<string>\",\n \"token\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"token_type_hint\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/oauth/introspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"<string>\",\n \"token\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"token_type_hint\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"client_id": "<string>",
"exp": 123,
"iat": 123,
"scope": "<string>",
"sub": "<string>",
"token_type": "<string>",
"username": "<string>"
}Authentication
Introspect a token
RFC 7662 token introspection: the calling client authenticates (client_id, plus client_secret for confidential clients) and submits a token to check, as form or JSON. Returns active true only for a token that the authenticated client itself issued and that is neither revoked nor expired, along with its scope, client_id, username, token_type, exp, iat, and sub; for any other token (unknown, expired, revoked, or belonging to a different client) it returns active false without leaking details.
POST
/
v1
/
oauth
/
introspect
Introspect a token
curl --request POST \
--url https://api.hq.zone/v1/oauth/introspect \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "<string>",
"token": "<string>",
"client_secret": "<string>",
"token_type_hint": "<string>"
}
'import requests
url = "https://api.hq.zone/v1/oauth/introspect"
payload = {
"client_id": "<string>",
"token": "<string>",
"client_secret": "<string>",
"token_type_hint": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '<string>',
token: '<string>',
client_secret: '<string>',
token_type_hint: '<string>'
})
};
fetch('https://api.hq.zone/v1/oauth/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.hq.zone/v1/oauth/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 => json_encode([
'client_id' => '<string>',
'token' => '<string>',
'client_secret' => '<string>',
'token_type_hint' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.hq.zone/v1/oauth/introspect"
payload := strings.NewReader("{\n \"client_id\": \"<string>\",\n \"token\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"token_type_hint\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
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.hq.zone/v1/oauth/introspect")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"<string>\",\n \"token\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"token_type_hint\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/oauth/introspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"<string>\",\n \"token\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"token_type_hint\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"client_id": "<string>",
"exp": 123,
"iat": 123,
"scope": "<string>",
"sub": "<string>",
"token_type": "<string>",
"username": "<string>"
}Token introspection (RFC 7662)
Reports whether a token is currently active and returns its metadata (scope, expiry, subject). Send the token as a form fieldtoken (application/x-www-form-urlencoded). Returns { "active": false } for unknown, expired, or revoked tokens.Body
application/json
RFC 7662. The calling client authenticates (client_id + secret for confidential). Form or JSON.