Revoking an API Key by an API Provider
An API provider or an administrator can use the Asset Details page to revoke an API key.
Revoking an API key by an API provider
1. Display the details page for the API whose key you want to revoke. 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. Move the mouse over the API key you want to revoke. This causes a Delete icon (
) to appear, that you can use for revoking the API key. 6. Click the icon to revoke the API key.
A confirmation message appears that the API key will be revoked.
Once the API key revocation is processed, CentraSite sends an email message to the API consumer informing that the request has been processed successfully.
CentraSite provides predefined email template for the API key revocation. By default, this template is configured in the centrasite.xml file. But, if you do not want to use the predefined email template, you can create and add your own email template to CentraSite, and configure the centrasite.xml file as necessary. For more information on creating and adding custom email templates to CentraSite, see CentraSite User’s Guide.
For more information on how to configure an email notification for API key revocation in the
CentraSite Business UI, see
Configuring the API Consumption
Settings.
