Page tree
Skip to end of metadata
Go to start of metadata

API Tokens are unique user authentication credentials used for integrating with the Apperian API. Whenever you send a request to an Apperian API resource, you need to provide a valid access token. The token tells the API which user is making the request and what that user has permission to access. 

You can use the Admin Portal to create API Tokens for any user in the system, though you should typically only create tokens for users with the Administrator role. One user can have multiple tokens if necessary. Tokens created through the Admin Portal can be used indefinitely for any API request, which is especially useful for repetitive automated tasks.

API Tokens can also be created and managed via the API. For more information, see Create API Token.

Best Practice

Apperian recommends using API Tokens for most API requests, with some exceptions. For a detailed description of API authentication, see Authentication.


Apperian User Authentication

API Token authentication is not related to user authentication in the Apperian Admin Portal, App Catalog, or other apps. For more information about Apperian Platform authentication, see Specify the User Authentication Method.

To create an API token
  1. On the Admin Portal navigation bar, click Settings.
  2. Click API Tokens.
  3. In the User field, search for a user by their First Name or Last Name (not User ID).
  4. Select the user.
  5. Click Create Token. The new token appears in the list of Active API Tokens.
To revoke an API token
  1. In the list of Active API Tokens, click the Revoke icon for a token.
  2. Click OK to confirm.