How to generate REST API Token
This guide shows how to retrieve a REST API token per user.
With the August Release 2023, we are introducing a way to generate the REST API Token. The token will be generated per user and it won't expire until the administrator updates it.
Requisites
Generate token for the first time
1. Enable the "REST API Token" under the user type editor.
2. Save the changes.
Enable the Token for the user:
1. After enabling the section, select a user from the list in the Manage Users window. You can access Manage Users through Main Menu > Admin > Manage Users.
2. Under the Rest API Token make sure that you enable and copy the key.
3. Ensure you Save the user; otherwise, the token will not be valid.
Note: Once you click the Save button, the token won't be visible anymore.
Regenerate the token
If you would like to regenerate the token, go to the User Edit form -> REST API Token tab.
Click the "Regenerate Token" button. The system will generate a new token here.
Warning: Once you click the save button, the old token will be deprecated and won't work anymore.
Summary:
- Only (1) token per user
- Generating a token will override any current token
- The token can be deleted or disabled through the "Enable REST API Token" button.
- The generated token won't expire until the administrator regenerates or deletes it.