Renewing Your API Key
API keys have an expiration period, which is set by the API provider. After an API key is generated, sometimes the API consumer might have to renew the old key due to expiration or security concerns. The API provider can also change the expiration period for the API key or set it so that the key never expires. For more information about configuring the API consumption settings for API key authentication, see Working with the CentraSite Business UI.
To request for renewal of an API key, the following prerequisites must be met:
API provider must have configured the predefined policy
API Key Renewal, which enables the
CentraSite Administrator, API Provider or designated approvers to approve or reject the "Renew API Key" requests. For more information about API key renewal policy, see
Working with the CentraSite Business UI.
A gateway instance (for example,
Mediator) should be up and running. For information on gateways, see
Run-Time Gateways.
The consumer must be a registered consumer for the specified API. For more information on registering as consumers for an API, see
Consumer Registrations.
To renew your API key
1. In the My API Keys section, displays a list of your API keys in CentraSite.
2. Move the cursor over the API key you want to renew. This causes a Renew icon to appear, that you can use for renewing.
3. Click the icon to renew the API key.
Important: | If the API key has unlimited expiration period, then this icon will not be displayed for that API key. |
Sometimes you might have to require an approval to renew the API key. If your API has the Require Approval configured in the API consumption settings, CentraSite will not renew the API key until the required approvals are obtained. However, if an approval workflow is not configured for the API, the API key is renewed immediately. For more information about approval actions, see Working with the CentraSite Business UI.
After renewing the API key, CentraSite automatically publishes the API to the Mediator, triggered by a Deploy Access Key action that is included in the API Key Renewal policy. For more information about the usage of this policy, see Working with the CentraSite Business UI.
Once the API key renewal request is approved by the designated approvers, CentraSite sends an email message to the API consumer informing the new validity of API key.
