Delete an API key

For security reasons, if you are concerned that a key has been given to someone in error, or otherwise compromised, you can delete it. You can also delete unused or obsolete API keys to keep the key list current. When a key is deleted, it is removed immediately and permanently from the system, and is unrecoverable. Future requests that use the deleted key will fail.

Managing API keys after user deletion

• Automatic removal: When a user is deleted or their credentials are removed, they are automatically disassociated from any API keys within a few hours.

• API key persistence: The API key itself remains in the list even after the user is deleted.

• Manual deletion: If the API key was solely for the deleted user, you can manually delete the key.

Before you begin

• User security privileges related to API keys are found on the Roles Setup page under the Framework, API Keys, View API Keys privilege Permissions associated with each role that define the features of the application a user is able to view and the functionality in the application the user can access.. To delete API keys, you must have the Edit API key privilege.

• The key to delete must be disabled.

Procedure 

1. Select the key to delete.

2. If they key is enabled, disable it now: 

   1. Under Actions, click the Edit icon .

   2. In the Generate key dialog box, clear the Enabled option.

   3. When prompted, confirm the action, and then click Save.

3. With the key selected, under Actions, click the Delete icon .

   

4. When prompted, confirm the action.

Related topics 

Generate an API Key