Renewing API Access Keys
To renew an API access key, you must belong to the API Runtime Provider role.
After an API access 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 access key or set it so that the key never expires.
Note: | The Renew functionality is not supported for the OAuth 2.0 access tokens. |
To renew an API access key, make sure that:
You have configured the API key authentication using the
API Consumption Settings action in the details page of the asset.
A gateway instance (for example,
Mediator) is up and running.
To renew an API key
1. In CentraSite Business UI, access the Advanced Search panel in one of the following ways:
Click the
Browse link in the upper-left corner of the menu bar.
Click the
Search icon next to the
Scope list. The default search scope is
Assets.
This displays a list of assets for which you have View permission in the Search Results page.
2. In the Additional Search Criteria list, select Asset Types.
3. To search for the assets of any type of Service, click Choose.
4. In the Choose Asset Types dialog box, select the Assets option button, and then follow these steps:
a. Click the chevron next to Assets option button.
b. In the displayed list of asset types, select the required type of Service.
c. Click OK.
5. In the displayed list of Service assets, click the asset for which you want to display the API access key details.
This opens the Service Details page.
6. Locate the hyperlinked text N next to Consumers attributes in the Basic Information profile.
7. Click on the hyperlinked consumer name whose API key you want to renew.
8. In the displayed list of API keys/OAuth 2.0 tokens, hover over the API key you want to renew.
This displays one or more actions you can perform on the API key.
9. Click the Renew icon.
Important: | If an API key has unlimited expiration period, then the Renew icon will not be displayed for that particular key. |
