Edit, reissue, or delete an API key
As an API key administrator, you can edit API key details and reissue or delete API keys.
Note:
For SAML users, avoid selecting an expiration date for the API key that occurs after the SAML session expires. If the date occurs after the session expires, this action can introduce a security risk with that API key.
You can edit the description of an API key or change the expiration date of an active API key.
To edit the expiration date or description for an API key
- On the left, select Security > API keys.
- Locate the API key that you want to edit.
- Click the Actions menu. Then select Edit.
- Note the current expiration date for the key and extend the date as wanted.
- Make any wanted changes to the description.
- Click Save.
Note:
For SAML users, avoid selecting an expiration date for the API key that occurs after the SAML session expires. If the date occurs after the session expires, this action can introduce a security risk with that API key.
When an API key expires you can reissue the API key. This action creates a new API key for the user.
To reissue an API key
- On the left, select Security > API keys.
- Locate the API key that you want to edit.
- Click the Actions menu. Then select Reissue > Reissue.
You can delete an API key to remove access for the user or when the key is no longer used. The key is permanently deleted, meaning that the associated user can no longer use that key for authentication.
To delete an API key
- On the left, select Security > API keys.
- Locate the API key that you want to view.
- Click the Actions menu. Then click Delete > Delete.