Editing an API Token

To edit an API token:

Note: You need the appropriate permissions to edit the API tokens assigned to a user.

1. Click Administration > API Tokens in the Navigation pane to display the API Tokens pane. All existing API token records display.

   Note: You can view API token records if you have the appropriate permissions and the tokens are still valid.

2. Click Edit on the TA toolbar.

   Note: If a different name is needed, change the API token name in the Name field. Ensure the name is unique.

3. Change the owner of the API token in the Owner field if a different owner is needed.

4. Select the appropriate user in the User field to generate their API token for.

5. Change the description for the API token in the Description field.

6. Set the updated expiration date in the Expiration Date field.

7. Select the desired number of uses for the API token from the Remaining Logins drop-down list.

   Note: The Unlimited checkbox next to the Remaining Logins field lets you control how many times the API token can be used. It's checked by default for unlimited logins. To restrict the number of logins, clear this checkbox and enter the desired limit.

   Note: Unchecking the Unlimited checkbox enables the Auto Delete Token option. To automatically delete the API token when the remaining logins reach zero, check Auto Delete Token.

8. Use the Max. API Calls/CM/Minute drop-down list to set the maximum number of API calls per minute per Client Manager instance.

   Note: The Unlimited checkbox is next to the Max. API Calls/CM/Minute field allows unlimited API calls per minute per Client Manager instance. To select the maximum number of API calls allowed per minute, clear this checkbox and enter the desired limit.

9. Use the Max. Concurrent Logins/CM drop-down list to set the maximum concurrent login limit per Client Manager instance.

   The Unlimited checkbox next to Max. Concurrent Logins/CM field allows unlimited concurrent client logins per every Client Manager instance.

10. Select the Session Token Time to Live field.

    If the Unlimited (Seconds) checkbox is selected, clear this checkbox to select the maximum number of seconds for which that the session token will be valid for use. The default value is 600 seconds. If not already selected, select Auto Refresh Session Token to automatically refresh or regenerate a new session token when it expires.

11. Select the Public checkbox to make the API token available to all TA users with the appropriate permissions to view the API token record if needed.

12. Select the Enabled checkbox, making the API token active and available for use if needed.

13. Click OK to save the changes.

Note: If you change the User or Expiration Date, you will see a message asking you to confirm. Once you confirm, your current API token will expire, and a new one will be created. You will then see a message confirming the new token.