Access Tokens are short-lived tokens that you use to authenticate Twilio client-side SDKs like Voice, Conversations, Sync, and Video.
You create them on your server to verify a user's identity and grant access to client API features. All tokens have a limited lifetime, configurable for up to 24 hours. However, a best practice is to generate Access Tokens for the shortest amount of time feasible for your application.
Each Access Token is a JSON Web Token (JWT), an encoded JSON object with three parts: the header, the payload, and the signature. The following is an example Access Token generated for Conversations.
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImN0eSI6InR3aWxpby1mcGE7dj0xIn0.eyJqdGkiOiJTS3h4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4LTE0NTA0NzExNDciLCJpc3MiOiJTS3h4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4Iiwic3ViIjoiQUN4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eCIsIm5iZiI6MTQ1MDQ3MTE0NywiZXhwIjoxNDUwNDc0NzQ3LCJncmFudHMiOnsiaWRlbnRpdHkiOiJ1c2VyQGV4YW1wbGUuY29tIiwiaXBfbWVzc2FnaW5nIjp7InNlcnZpY2Vfc2lkIjoiSVN4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eCIsImVuZHBvaW50X2lkIjoiSGlwRmxvd1NsYWNrRG9ja1JDOnVzZXJAZXhhbXBsZS5jb206c29tZWlvc2RldmljZSJ9fX0.IHx8KeH1acIfwnd8EIin3QBGPbfnF-yVnSFp5NpQJi0
If you inspect it with the debugger at jwt.io, you can further explore its content.
1{2"typ": "JWT",3"alg": "HS256",4"cty": "twilio-fpa;v=1"5}
The header
section encodes the format of the token:
typ
is the type of token. Its value must be "JWT"
.alg
is the algorithm used to encode the token. Its value must be "HS256"
.cty
is the content type and encodes the version of the Access Token. Its value must be "twilio-fpa;v=1"
.1{2"jti": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-1450471147",3"iss": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",4"sub": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",5"iat": 1450471147,6"nbf": 1450471147,7"exp": 1450474747,8"grants": {9"identity": "user_name",10"chat": {11"service_sid": "ISxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"12}13}14}
The payload
section describes the authorization granted:
jti
is a unique identifier for the token. Your application can choose this identifier. The default helper library implementation includes the SID of the API key used to generate the token and a unique random string.iss
is the issuer — the API key containing the secret used to sign the token.sub
is the SID of the Twilio Account to which access is scoped.iat
is the timestamp at which the token was issued.nbf
is an optional timestamp, before which the token will NOT be accepted.exp
is the timestamp at which the token will expire. Tokens have a maximum age of 24 hours.grants
is the list of permissions that the token grants. Grant properties and values will depend on the Twilio product and the needs of your specific use case. (See the Grants section below for more information.)The signature
section is a signed hash that serves to prove the authenticity of the token. It is the result of hashing the JWT header and payload together with your API key secret, which should only be known to your application and Twilio.
Twilio Access Tokens are based on the JSON Web Token standard.
You can use one of Twilio's Helper Libraries to create Access Tokens quickly and programmatically.
Every Access Token requires your Account SID, which you can find in your Twilio Console. This is how the AccessToken will tie a user's activity to a specific Twilio account.
Next, you need to create an API key. You can create API keys from the Twilio Console or with the REST API.
Note: You can create Access Tokens using Main and Standard API Keys. Creating Access Tokens is not yet supported with Restricted API Keys.
If you are creating a key to use with Twilio Video, you must create it in the US1 Region. Learn more in the Twilio Video documentation.
When you create the API key, you'll be shown the key's secret, which is used to sign the Access Token. For security, you will only be shown the secret at this time, so you need to store it with the key's SID in a secure location for the next step.
Now use the information gathered in steps 1 and 2 to generate an Access Token using a Twilio Helper Library.
When creating an Access Token, you must provide:
You can also optionally provide any of the following JWT configuration values.
Parameter | Description | Example |
---|---|---|
identity | The identity to associate with the Access Token. Typically, this will be a username in your system. Voice tokens may only contain alpha-numeric and underscore characters. | user_name |
ttl | Time to live for the token, in seconds. | 3600 |
nbf | Token not before time, or the time before which the token will NOT be accepted. Values are in Epoch time. | 1615404972 |
region | The intended Twilio Region for the token. Currently only supported for Voice tokens. | us1 |
Each Twilio product will also require at least one "grant", which will provide product-specific abilities to the user associated with an Access Token.
Programmable Voice access tokens limit the number of concurrent sessions for a given identity to ten. When the 11th instance of the identity is registered the oldest registration is removed.
Below are code samples for creating Access Tokens with Twilio Helper Libraries. Click on a product below to jump to the related code samples.
The Conversations SDK requires each Access Token to contain a ChatGrant
. Each ChatGrant
must contain the SID for your Conversation Service. Each Access Token will also contain an identity
grant that associates an Access Token with a specific user.
1const AccessToken = require('twilio').jwt.AccessToken;2const ChatGrant = AccessToken.ChatGrant;34// Used when generating any kind of tokens5// To set up environmental variables, see http://twil.io/secure6const twilioAccountSid = process.env.TWILIO_ACCOUNT_SID;7const twilioApiKey = process.env.TWILIO_API_KEY;8const twilioApiSecret = process.env.TWILIO_API_SECRET;910// Used specifically for creating Chat tokens11const serviceSid = process.env.TWILIO_CHAT_SERVICE_SID;12const identity = 'user@example.com';1314// Create a "grant" which enables a client to use Chat as a given user,15// on a given device16const chatGrant = new ChatGrant({17serviceSid: serviceSid,18});1920// Create an access token which we will sign and return to the client,21// containing the grant we just created22const token = new AccessToken(23twilioAccountSid,24twilioApiKey,25twilioApiSecret,26{identity: identity}27);2829token.addGrant(chatGrant);3031// Serialize the token to a JWT string32console.log(token.toJwt());
1const AccessToken = require('twilio').jwt.AccessToken;2const VoiceGrant = AccessToken.VoiceGrant;34// Used when generating any kind of tokens5// To set up environmental variables, see http://twil.io/secure6const twilioAccountSid = process.env.TWILIO_ACCOUNT_SID;7const twilioApiKey = process.env.TWILIO_API_KEY;8const twilioApiSecret = process.env.TWILIO_API_SECRET;910// Used specifically for creating Voice tokens11const outgoingApplicationSid = 'APxxxxxxxxxxxxx';12const identity = 'user';1314// Create a "grant" which enables a client to use Voice as a given user15const voiceGrant = new VoiceGrant({16outgoingApplicationSid: outgoingApplicationSid,17incomingAllow: true, // Optional: add to allow incoming calls18});1920// Create an access token which we will sign and return to the client,21// containing the grant we just created22const token = new AccessToken(23twilioAccountSid,24twilioApiKey,25twilioApiSecret,26{identity: identity}27);28token.addGrant(voiceGrant);2930// Serialize the token to a JWT string31console.log(token.toJwt());
The Voice SDKs require each Access Token to contain an identity
grant and a VoiceGrant
. The identity
grant is what associates an Access Token with a specific user.
Each VoiceGrant
contains the following parameters:
Parameter | Type | Description |
---|---|---|
incomingAllow | Boolean | Indicates whether or not the endpoint associated with this Access Token is allowed to receive incoming calls as the identity included in the Access Token |
outgoingApplicationSid | string | The SID of the TwiML App that Twilio will look to when making outgoing calls. (Note: This is required for using any of the Voice SDKs.) |
outgoingApplicationParams | object | Request parameters to send to the TwiML Application for outgoing calls |
pushCredentialSid | string | The SID of the Push Credential to use when registering to receive incoming call notifications (Mobile SDKs only) |
The payload of a decoded Voice AccessToken will look something like the following:
1{2"jti": "SKxxxx...-1643993631",3"grants": {4"identity": "alice",5"voice": {6"incoming": {7"allow": true8},9"outgoing": {10"application_sid": "APxxxx..."11},12"push_credential_sid": "CRxxxx..."13}14},15"iat": 1643993631,16"exp": 1643997231,17"iss": "SKxxxx...",18"sub": "ACxxxx..."19}
The API Key you use to create an Access Token for Twilio Video must be in the US1 region.
The Video SDKs require each Access Token to contain an identity
grant and a VideoGrant
.
The identity
grant is what associates an Access Token with a specific user.
Each VideoGrant
contains an optional room
parameter for a specific Room name or SID, which indicates the holder of the Access Token may only connect to the indicated Room.
Learn more about Video Access Tokens on the User Identity & Access Tokens page.
1const AccessToken = require('twilio').jwt.AccessToken;2const VideoGrant = AccessToken.VideoGrant;34// Used when generating any kind of tokens5// To set up environmental variables, see http://twil.io/secure6const twilioAccountSid = process.env.TWILIO_ACCOUNT_SID;7const twilioApiKey = process.env.TWILIO_API_KEY;8const twilioApiSecret = process.env.TWILIO_API_SECRET;910const identity = 'user';1112// Create Video Grant13const videoGrant = new VideoGrant({14room: 'cool room',15});1617// Create an access token which we will sign and return to the client,18// containing the grant we just created19const token = new AccessToken(20twilioAccountSid,21twilioApiKey,22twilioApiSecret,23{identity: identity}24);25token.addGrant(videoGrant);2627// Serialize the token to a JWT string28console.log(token.toJwt());
Sync requires your Access Token to contain an identity
grant and a SyncGrant
. The identity
grant is what associates an Access Token with a specific user.
The SyncGrant
requires a serviceSid
parameter containing the SID for your Sync Service.
Learn more about Sync Access Tokens on the Issuing Sync Tokens page.
1const AccessToken = require('twilio').jwt.AccessToken;2const SyncGrant = AccessToken.SyncGrant;34// Used when generating any kind of tokens5// To set up environmental variables, see http://twil.io/secure6const twilioAccountSid = process.env.TWILIO_ACCOUNT_SID;7const twilioApiKey = process.env.TWILIO_API_KEY;8const twilioApiSecret = process.env.TWILIO_API_SECRET;9const twilioSyncService = process.env.TWILIO_SYNC_SERVICE_SID;1011// Used specifically for creating Sync tokens12const identity = 'user';1314// Create a "grant" which enables a client to use Sync as a given user15const syncGrant = new SyncGrant({16serviceSid: twilioSyncService,17});1819// Create an access token which we will sign and return to the client,20// containing the grant we just created21const token = new AccessToken(22twilioAccountSid,23twilioApiKey,24twilioApiSecret,25{ identity: identity }26);27token.addGrant(syncGrant);2829// Serialize the token to a JWT string30console.log(token.toJwt());
Now you're ready to use your token. For client-side SDKs like Conversations, Voice, and Video, you will need to get the stringified token to your client-side code via Ajax or some other means.
Refer to the Identity and Access Tokens guides in the product documentation for Video, Conversations, Sync for more details.
You can use API keys to manage the lifecycle of Access Tokens.
Since each Access Token was created using an API Key, you can delete the API key to revoke all of the Access Tokens related to that API Key.