Renewing an API Key
After an API key is generated, sometimes you might have to renew the old key due to expiration or security concerns. You can also change expiration period for the API key or set it so that the key never expires.
Note: | The Renew option is not available for the OAuth 2.0 tokens. |
To renew an API key, the following prerequisites must be met:
Ensure that you have configured the API Consumption Settings so that the API is configured for either API key authentication or OAuth2 authentication, as described in
Configuring the API Consumption
Settings.
Ensure that a gateway instance (for example,
Mediator) is up and running. For information on creating and managing gateways, see
Run-Time Governance with CentraSite.
The API provider (and users who belong to a role with the permissions stated above), can renew an API key.
To renew an API key
1. Display the details page for the API whose key you want to renew. If you need procedures for this step, see Viewing Details for an API. 2. Locate the hyperlinked text “N” Consumers in the description area of the Basic Information profile, for example, “N” Consumers.
3. Click on the hyperlinked number “N” to see the list of keys available for the API.
4. Click on the hyperlinked API key name to see more information about who consume the API.
5. Review expiration date of the API key. A value of "Unlimited" indicates that the key never expires.
6. Move the mouse over the API key you want to renew. This causes a Renew icon (
) to appear, that you can use for renewing the API key. Important: | If the API key has unlimited expiration period, then this icon will not be displayed for that API key. |
7. Click the icon to renew the API key.
