OAuth · Revoke tokens

POST /oauth/revoke

cURL

cURL

curl --request POST \
  --url https://api.sandbox.humanity.org/v2/oauth/revoke \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>",
  "tokens": [
    "<string>"
  ],
  "token_type_hint": "<unknown>",
  "authorization_id": "<string>",
  "cascade": "<unknown>",
  "client_id": "<string>"
}
'

import requests

url = "https://api.sandbox.humanity.org/v2/oauth/revoke"

payload = {
    "token": "<string>",
    "tokens": ["<string>"],
    "token_type_hint": "<unknown>",
    "authorization_id": "<string>",
    "cascade": "<unknown>",
    "client_id": "<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({
    token: '<string>',
    tokens: ['<string>'],
    token_type_hint: '<unknown>',
    authorization_id: '<string>',
    cascade: '<unknown>',
    client_id: '<string>'
  })
};

fetch('https://api.sandbox.humanity.org/v2/oauth/revoke', 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.sandbox.humanity.org/v2/oauth/revoke",
  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([
    'token' => '<string>',
    'tokens' => [
        '<string>'
    ],
    'token_type_hint' => '<unknown>',
    'authorization_id' => '<string>',
    'cascade' => '<unknown>',
    'client_id' => '<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.sandbox.humanity.org/v2/oauth/revoke"

	payload := strings.NewReader("{\n  \"token\": \"<string>\",\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"token_type_hint\": \"<unknown>\",\n  \"authorization_id\": \"<string>\",\n  \"cascade\": \"<unknown>\",\n  \"client_id\": \"<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.sandbox.humanity.org/v2/oauth/revoke")
  .header("Content-Type", "application/json")
  .body("{\n  \"token\": \"<string>\",\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"token_type_hint\": \"<unknown>\",\n  \"authorization_id\": \"<string>\",\n  \"cascade\": \"<unknown>\",\n  \"client_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.humanity.org/v2/oauth/revoke")

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  \"token\": \"<string>\",\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"token_type_hint\": \"<unknown>\",\n  \"authorization_id\": \"<string>\",\n  \"cascade\": \"<unknown>\",\n  \"client_id\": \"<string>\"\n}"

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

200

{
  "revoked": true,
  "revoked_count": 123,
  "details": [
    {
      "subject": "<unknown>",
      "status": "<unknown>",
      "token_type": "<unknown>",
      "authorization_id": "<string>",
      "client_id": "<string>",
      "user_id": "<string>",
      "reason": "<string>"
    }
  ]
}

SDK equivalent

await sdk.revokeTokens({
  token: refreshToken,
  tokenTypeHint: 'refresh_token',
});

Invalidate refresh or access tokens when a user disconnects Humanity or when you need to force-logout compromised sessions. Pass either a single token or an array of tokens, plus optional hints (authorization, refresh_token, access_token) to speed up resolution.

Revocations cascade through Humanity’s cache, so subsequent /oauth/token refresh attempts fail immediately. Pair this with /auth/logout if you maintain your own tenant-scoped sessions.

Body

application/json

token · string

tokens · string[]

token_type_hint · Option 1 · any Option 2 · any Option 3 · any

authorization_id · string

cascade · Option 1 · any Option 2 · any Option 3 · any Option 4 · any Option 5 · boolean

client_id · string

Response

200 - application/json

revoked · boolean · required

revoked_count · number · required

details · object[]

Show child attributes