OAuth2 Client Generation Policy

CentraSite Documentation : Working with the CentraSite Business UI : API Management Solutions : Predefined Policies for API Management : The OAuth2 Client Management Policies : OAuth2 Client Generation Policy

If you will be using the OAuth 2.0 protocol and you have successfully registered as a consumer for an API, CentraSite internally triggers an OAuth2 Client Generation policy to generate the OAuth2.0 credentials (access token).

Object Scope

Virtual Service

Virtual XML Service

Virtual REST Service

Event Scope

OnTrigger

Policy Actions

The OAuth2 Client Generation Policy includes the following built-in actions:

Initiate Approval - Initiates an approval workflow.

OAuth Client Generator - Generates the OAuth2 client credentials (a client_id and client_secret) which authorizes the consumer to access and use the API, thereby creating a relationship between the API and the specified consumer.

Input Parameters
OAuth Token Expiration Interval	String. Mandatory. Specifies the time interval an OAuth token can remain active. When the interval expires, the current OAuth token is marked expired.

Deploy OAuth Client - Initiates an OAuth token 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.

Input Parameters

None.

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.

Contact Support | Community | Feedback