CentraSite Documentation : Working with the CentraSite Business UI : API Management Solutions : Predefined Policies for API Management : The Access Key Management Policies : API Key Generation Policy
API Key Generation Policy
 
Initiate Approval Action
API Key Generator Action
Deploy API Key Action
Send Email Notification Action
To prevent unauthorized access of an API, API Providers generate the API key which serve as an user access token for identify the final consumer of the particular API.
When a consumer registers as a consumer for an API (as described in Run-Time Governance with CentraSite ), CentraSite internally creates and triggers an API Key Generation policy for the API. A request for the API consumption is subsequently submitted to all members of the approval list specified in the Initiate Approval action. The approvers can either approve or decline the request. If the approvers approve the request, CentraSite generates the API key, deploys the generated key in the Mediator, and notifies the consumer that the API is now ready for consumption using the generated key.
Note:  
To use the email options provided by this policy, CentraSite must have a connection to an SMTP email server. For instructions on how to configure CentraSite's connection to an email server, see the CentraSite Administrator’s Guide .
The following actions are typically used with the API Key Generation policy.
*The Initiate Approval action is generally used to obtain necessary approvals for a consumer prior to executing the API Key Generator action.
*The API Key Generator action is used to generate the API key for an API, and thereby create a relationship between the API and the specified consumer.
*The Deploy API Key is typically executed after the API Key Generator action to deploy the generated key in the Mediator.
*The Send Email Notification action is used to send an email message with details of the new API key to the consumer.
Object Scope
Virtual Service, XML Service, REST Service, Virtual XML Service, Virtual REST Service
Event Scope
OnTrigger
Copyright © Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback