Generate API Keys for API-Only Users

You can generate API keys for API-Only users. You cannot generate API keys for employees

You must be a System Administrator to perform these steps.

Important: API keys have a maximum expiration date that is three months in the future. If you try to create an API key with a longer active period, WorkBook still sets the expiration date to three months from the creation date. If you use API keys for admin integrations, you must set up a key rotation process.

To generate API keys for API-only users:

1. Navigate to Settings > Advanced Tools > User Access Rights.
2. In the left pane, click API Users (below the main tab bar).
3. Expand API-Only Role in the left pane (below API Users) to display the list of API-Only users.
4. Select the name of the API-Only user for which you want to create an API key by clicking on it.
5. In the right pane, click the API Key Setup tab in the main tab bar.
6. Click Generate New API Key.
   The Generate API Key dialog box is displayed. Note that all fields are optional.
7. Click the calendar icon in the Expiration Date field to select an expiration date.
   The default date for the expiration date is three months from the creation date. If you try to select a date that is more than three months in the future, WorkBook still sets the expiration date at three months from the creation date.
8. Enter text to help identify the purpose of this API key in the Note field.
9. Click Create to create the API key.
   An information dialog box displays the value of the new API key.

   Important: Be sure to note this value because it is never displayed again, for security reasons.

10. Click OK to close the information dialog box.
    The new API key is added to the grid for the selected API-Only user.