API Key Generation Policy
To prevent unauthorized access of an API, API Providers generate an access key which serve as the user access token for identifying the final consumer of the particular API.
When a user/consumer appplication registers as a consumer for an API (as described in Run-Time Governance with CentraSite), CentraSite internally triggers an API Key Generation policy for the API. A request for the API consumption is subsequently submitted to all members of the specified approval list. The approvers can either approve or decline the request. If the approvers approve the request, CentraSite generates the access key, deploys the generated key in the Mediator, and notifies the consumer that the API is now ready for consumption using the generated key.
Object Scope
The API Key Generation policy operates on the following object:
Virtual Service
Virtual XML Service
Virtual REST Service
Event Scope
OnTrigger
Policy Actions
The API Key Generation policy includes the following built-in actions:
Initiate Approval - Initiates an approval workflow.
API Key Generator - Generates an access key which authorizes the consumer to access and use the API, thereby creating a relationship between the API and the specified consumer.
Input Parameters |
Key Expiration Interval | String. Mandatory. Specifies the time interval an access key can remain active. When the interval expires, the current key is marked expired. |
Deploy API Key - Initiates an access key deployment in the gateway (for example, Mediator).
Note: | If the gateway is down/unreachable, this action will fail. In this case, the API Provider is notified through the configured email. |
Create Auditable Events - Creates an audit log record about the generation of the access key.
Send Email Notification - Sends an email message to specified a group of users.
For more information about configuring the parameters for built-in actions, see the CentraSite Developer’s Guide.
