Verify an authentication token | Sample

1 parameter

tokenstringrequired

Authentication token supplied in the request header; the required scope is `none`.

2 status codes

200Returns `ok` set to true, the workspace URL and name, `team_id`, `user`, and `user_id`; an enterprise installation may also include `is_enterprise_install` and `bot_id`.

bot_idstringoptional

is_enterprise_installbooleanoptional

okbooleanrequired

Allowed:true

teamstringrequired

team_idstringrequired

urlstringrequired

userstringrequired

user_idstringrequired

defaultReturned when the token is invalid, revoked, inactive, or the request cannot be parsed; 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_authtoken_revokedaccount_inactiveinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_typemissing_post_typeinvalid_jsonjson_not_object

okbooleanrequired

Allowed:false

Error handling

token must be supplied in the request header as a valid authentication token. The token must resolve to a team and user identity for the response to include the required identifiers.

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.authTest.list();

{
  "ok": true,
  "team": "Subarachnoid Workspace",
  "team_id": "T12345678",
  "url": "https://subarachnoid.slack.com/",
  "user": "grace",
  "user_id": "W12345678"
}

Request

Response

Errors