Manage API keys
/login endpoint or API keys. Instead, use one of the following authentication methods:- Server authentication with JWT
- User authentication with OAuth2
In order to minimize API security vulnerabilities, Adobe Workfront administrators can manage the API Keys used to enable applications to access Workfront on behalf of a user.
You can reset or remove your current administrator API Key, configure API Keys to expire, and remove the API Keys for all users.
Examples of applications that leverage the Workfront API are:
- Document integrations such as Dropbox, Google Drive, and Workfront DAM
- Workfront mobile applications
Access requirements
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront package | Any |
| Adobe Workfront license |
Standard Plan |
| Access level configurations | You must be a Workfront administrator. |
For information, see Access requirements in Workfront documentation.
Workfront API Keys
Each user in Workfront has a unique API Key. This key is generated on a per-user basis at the time the user accesses an integration that leverages the Workfront API (such as the Workfront mobile app or a document integration).
Workfront administrators also have a unique API Key. When an application uses an administrator API Key to access Workfront, the application has administrator access to Workfront.
Manage an administrator API key
You can generate, reset, or remove the API Key for your administrator user account.
-
Click the Main Menu icon
in the upper-left corner of Adobe Workfront, then click Setup
.
-
Click System > Customer Info.
-
(Conditional) Perform one of the following actions:
To generate an API Key: In the API Key Settings section, click Generate API Key.
Or
To reset an API Key: In the API Key Settings section, click Reset, then Reset.Or
To remove the API Key: In the API Key Settings section, click Remove, then Remove.
Configure when API keys expire
You can configure API Keys to expire for all users in your system. When the API Key of a user expires, the user must re-authenticate to any applications that use the Workfront API to access Workfront. You can change the frequency with which the API Keys expire. You can also configure whether API Keys expire when the password of a user expires.
-
Click the Main Menu icon
in the upper-left corner of Adobe Workfront, then click Setup
.
-
Click System > Customer Info.
-
In the API Key Settings area, in the After creation, API keys expire in drop-down list, select the timeframe when you want the API keys to expire.
When you change this option, the new timeframe begins from the time that you made the change. For example, if you change this option from 1 month to 6 months, the API Keys expire 6 months from the time you make the change.
By default, API Keys expire each month.
-
To configure API Keys to expire at the time the users’ passwords expire, enable Remove API key when a user’s password expire.
By default, this option is not enabled.
For information about how to configure user passwords to expire, see Configure system security preferences.
-
Click Save.
Remove the API keys for all users
If you are concerned about a particular security breach regarding your Workfront system, you can remove API Keys simultaneously for all users.
-
Click the Main Menu icon
in the upper-left corner of Adobe Workfront, then click Setup
.
-
Expand System, then click Customer Info.
-
In the API Key Settings area, click Remove all API keys, then click Remove All.