REST API: Auth Token

(warning)

Warning

If you are using Services or Functions(Classic) and have included your auth token directly instead of using a variable, you must wait for 1 minute for the update of your auth token to propagate. Otherwise, those functions and services will fail with a 403 Forbidden error.

Twilio uses the Account SID and Auth Token to authenticate API requests. You can rotate the Auth Token in the Twilio Console or by using this API. Two related endpoints help you manage Auth Tokens: use the Secondary Auth Token endpoint to create or delete a secondary token, and use this endpoint to promote the secondary token.

Auth Token properties

Property nameTypeRequiredPIIDescriptionChild properties

accountSidSID<AC>

Optional

Not PII

The SID of the Account that the secondary Auth Token was created for.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

authTokenstring

Optional

PII MTL: 0 days

The promoted Auth Token that must be used to authenticate future API requests.

dateCreatedstring<date-time>

Optional

Not PII

The date and time in UTC when the resource was created specified in ISO 8601 format.

dateUpdatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring<uri>

Optional

Not PII

The URI for this resource, relative to https://accounts.twilio.com

Update an AuthTokenPromotion resource

POST https://accounts.twilio.com/v1/AuthTokens/Promote

This action deletes the current primary Auth Token and promotes the secondary Auth Token to primary.

(warning)

Rotating Auth Tokens for many subaccounts

Each Auth Token change sends email to every owner and administrator of the account. Rotating Auth Tokens across many subaccounts at once can generate a high volume of email, which can delay other messages that Twilio sends to the same recipients, such as Console verification codes.

We recommend setting SuppressEmailNotification to true when you rotate Auth Tokens for a large number of accounts, and telling your users about the rotation through your own channels.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

suppressEmailNotificationboolean

Optional

Not PII

Whether to suppress the email notification that Twilio sends to the owners and administrators of the account about this Auth Token change. Defaults to false, so Twilio sends the email. Set to true when rotating Auth Tokens across many subaccounts.

Promote the Secondary Auth Token

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateAuthTokenPromotion() {
11  const authTokenPromotion = await client.accounts.v1
12    .authTokenPromotion()
13    .update({ suppressEmailNotification: false });
14
15  console.log(authTokenPromotion.accountSid);
16}
17
18updateAuthTokenPromotion();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "auth_token": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
4  "date_created": "2015-07-31T04:00:00Z",
5  "date_updated": "2015-07-31T04:00:00Z",
6  "url": "https://accounts.twilio.com/v1/AuthTokens/Promote"
7}