Revoke access token | Sample - Box Platform API

3 body fields

client_idstringoptional

The Client ID of the application requesting to revoke the access token.

client_secretstringoptional

The client secret of the application requesting to revoke an access token.

tokenstringoptional

The access token to revoke.

3 status codes

200Returns an empty response when the token was successfully revoked.

400An authentication error.

errorstringoptional

The type of the error returned.

error_descriptionstringoptional

The type of the error returned.

defaultAn authentication error.

errorstringoptional

The type of the error returned.

error_descriptionstringoptional

The type of the error returned.

Error handling

A 400 is returned: An authentication error. Any other status is an error: An authentication error.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    clientId: process.env.CLIENT_ID,
    clientSecret: process.env.CLIENT_SECRET,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.revoke.create({
  clientId: "c0a80123-4567-89ab-cdef-0123456789ab",
  clientSecret: "sk_live_4eC39Hq",
  oauth: "sk_live_4eC39Hq",
});

{
  "error": "invalid_client",
  "error_description": "The client credentials are not valid"
}

Request

Response

Errors