About API Tokens

This article describes the use of API Tokens, based on OAuth 2.0 authentication protocol, as a means to access our APIs. 

Rules for Using API Tokens

• Tokens will automatically expire and be deleted after 180 days (regardless of whether the token was in use, or not). Once expired and deleted, the token will not be available to the user, and the user account will not have access to our APIs. Therefore, API tokens must be revoked and regenerated, before they expire.
• Only one API token can exist, for any user, at any one time.
• After generating a new API token, insert the new access key generated, into the script in the API. See our API documentation. 
• API tokens are cross-regional (one API token for all regions). The user’s access is determined by his role and the Business Units he belongs to. 
• If you need to disable the API Token option (to limit access by users), contact support. 

Creating an API Token

Creating an API Token for Accounts without SSO

To create an API token for a user account without SSO:

1. Sign in to your  account              
   (see Signing In).
2. From the user dropdown menu on the upper right-hand corner, go to Edit Profile.  

3. At the bottom of the API Token section, click Generate. 

4. The New API Token dialog box appears.           
   
             
    
5. The newly generated personal API Token appears (hidden) in the field.            
   If you want to view the hidden API token string, click the view icon (optional). 
6. Click Copy to copy the token into your clipboard.    

7. An email will be sent to the user, confirming the creation of a new API Token.                    
8. After generating a new API token, insert the new access key generated into the script in the API. See our API documentation.

Creating an API Token for Accounts with SSO

To create an API token for a user account with SSO:

1. Sign in to your account (see Signing In).
2. From the user dropdown menu on the upper right-hand corner, go to Edit Profile.  

3. At the bottom of the API Token section, click Generate. 

4. A popup window appears. Read the instructions carefully.           

To generate an API Token, you will have to authenticate with a password, as described:

1. If you don’t have an account password, or if it has expired, click the Reset Password link, and follow the on-screen instructions. For more information on resetting passwords, see Resetting Passwords.

NOTE: At the end of the reset password process, the system will attempt to log you in automatically. However, since your account is configured with SSO, you will see the following error message.


Please ignore this error message, and return to the Edit Profile page.

2. If you already have a password, click Continue. 

3. Enter your account login credentials in the sign-up page, where you will be redirected.  

5. Once authenticated, you will be returned to the New API Token window, where a new API Token will be provided.

6. The newly generated personal API Token appears (hidden) in the field.

If you want to view the hidden API token string, click the view icon (optional). 

7. Click Copy to copy the token into your clipboard.
8. An email will be sent to the user, confirming the creation of a new API Token.
9. After generating a new API token, insert the new access key generated, into the script in the API. See our API documentation.         

Revoking an Existing API Token        

To replace an existing API Token in your account, you must first revoke the existing API token (since only one API token can exist at any given time, for any user). 

1. Sign in to your account (see Signing In).
2. From the user dropdown menu on the upper right-hand corner, go to the Edit Profile page, and click Revoke.

3.  The Revoke API token confirmation dialog box appears.

4. Read the warning message, and then click Revoke, to confirm revoking the API token.

5. You receive an email message confirming that your API token has been revoked.