Revoke an authentication token | Sample

2 parameters

tokenstringrequired

Authentication token to revoke; the required scope is `none`.

testbooleanoptional

Testing-mode flag that prevents revocation when set to `1`.

2 status codes

200Returns an object with `ok` set to true and a `revoked` boolean indicating whether the token was revoked.

okbooleanrequired

Allowed:true

revokedbooleanrequired

defaultReturned when the token is not authenticated, is invalid, or the request parameters cannot be processed; the response contains `ok` set to false and an `error` value.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requiredinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_typemissing_post_type

okbooleanrequired

Allowed:false

Error handling

token must identify the authentication token to revoke. Set test to 1 when you want testing mode, which leaves the token active instead of revoking it.

import { Client } from "acme-sdk";

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

const result = await client.authRevoke.list({
  token: "sk_live_4eC39Hq",
  test: "example",
});

{
  "ok": true,
  "revoked": true
}

Request

Response

Errors