Managing API Tokens

About API tokens

Every user has an API token, but an individual user must have the API Access permission in order to make API calls with their auth token. For more information, see our API documentation. 

The instructions in this article are for on-premise / private cloud instances. For SaaS instances, see API Access for SaaS Instances

Viewing user auth tokens & details

You can view your own API token in the application. Depending on your permissions, you may also be able to see the tokens of other users, along with other authentication details.

Viewing your own API token

All users can see their own API token. 

To see your token, click on your username in the upper-right corner of an application page, and then click Show API Auth Token from the menu that appears. ShowAPIAuthToken.png

Viewing details of other users

If you’re a System Admin, you can view the API token and other details for any user in your instance. To do so:

  1. Click Users in the left-hand sidebar.

  2. In the table, click on a user’s name to see their API token, last login, email, permission group, and their authentication groups.

  3. Click Done to go back to the list of users.

Resetting API tokens

If a user needs a new API token and you are a System Admin, you can reset their token. Doing so also logs the user out of any active sessions.

To reset users’ API tokens:

  1. Click Users in the left-hand sidebar.

  2. In the table, select the checkboxes for the users you would like to create new API tokens for.

  3. Click Actions, and then click Reset Authentication.

  4. Click OK.