Revoke refresh tokens

Revoke refresh tokens in bulk by ID list, user, user+client, or user+client+audience.

POST https://{tenantDomain}/api/v2/refresh-tokens/revoke

Revoke refresh tokens

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/refresh-tokens/revoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "user_id": "<string>",
  "client_id": "<string>",
  "audience": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/refresh-tokens/revoke"

payload = {
    "ids": ["<string>"],
    "user_id": "<string>",
    "client_id": "<string>",
    "audience": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ids: ['<string>'],
    user_id: '<string>',
    client_id: '<string>',
    audience: '<string>'
  })
};

fetch('https://{tenantDomain}/api/v2/refresh-tokens/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://{tenantDomain}/api/v2/refresh-tokens/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([
    'ids' => [
        '<string>'
    ],
    'user_id' => '<string>',
    'client_id' => '<string>',
    'audience' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://{tenantDomain}/api/v2/refresh-tokens/revoke"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"user_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"audience\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{tenantDomain}/api/v2/refresh-tokens/revoke")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"user_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"audience\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/refresh-tokens/revoke")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"user_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"audience\": \"<string>\"\n}"

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

application/jsonapplication/x-www-form-urlencoded

Exactly one of the following combinations must be provided: ids (up to 100 token IDs); user_id; user_id + client_id; or user_id + client_id + audience. ids cannot be combined with user_id, client_id, or audience. audience requires both user_id and client_id. client_id alone is not allowed — it must be paired with user_id.

ids · string[]

Array of refresh token IDs to revoke. Limited to 100 at a time.

Minimum array length: 1

Required string length: 1 - 30

user_id · string<user-id>

Revoke all refresh tokens for this user.

Required string length: 1 - 300

client_id · string<client-id>

Revoke refresh tokens for this client. Must be paired with user_id; optionally narrowed further with audience.

Required string length: 1 - 64

audience · string

Resource server identifier (audience) to scope the revocation. Must be used with both user_id and client_id.

Required string length: 1 - 600

レスポンス

202

Refresh token revocation request accepted.