
	Version 9.6	SEARCH CONTENTS \| PDF BOOKS \| HOME UP PREV NEXT

— API Management Solutions —

Working with Predefined Policies

CentraSite's approval-management framework enables you to review a request and approve or reject the request when certain time events occur in the registry. For example, you might require a system architect to review and approve all APIs before they are switched to a productive state.

To impose an approval process on a change time event, you create an approval policy for the event. An approval policy is a policy that contains one of CentraSite's built-in approval actions.

The content is organized under the following topics:

Summary of the Predefined Policies
User Registration Policies
Consumer Onboarding Policies
API Key Generation Policy
API Key Renewal Policy
API Key Revocation Policy

Summary of the Predefined Policies

CentraSite provides predefined policies specific to the Business UI.

By default, predefined policies are not displayed by CentraSite Control. To view predefined policies, you must enable the Show Predefined Policies option on the Design/Change-Time Policy page.

Policy Name	Description
Global New User Account	See Using the User Registration Policy.
Global Onboarding	See Using the Consumer Onboarding Policy.
API Key Generation	See Using the API Key Generation Policy.
API Key Renewal	See Using the API Key Renewal Policy.
API Key Revocation	See Using the API Key Revocation Policy.

User Registration Policies

The New Account policies trigger an approval workflow when users request for an account in the CentraSite registry.

When users request a CentraSite account (as described in Creating Your New Account), the policy is triggered and the "User Registration" or an "Organization with User Registration" request is submitted to all members of the approval list specified in the "Initiate Approval" action. Then, the approvers can either approve or decline the request. If the approvers approve the request, the users will be registered in the CentraSite registry, and appropriate permissions will be assigned to users.

To use the CentraSite's new account feature, you must configure the "Global New User Account Policy" and every organization's "New User Account Policy".

Note:
You do not need to explicitly activate the new account policies.

Global New User Account Policy

The Global New User Account Policy enables an automated user registration to address the following scenarios:

If the user does not explicitly specify an organization, the policy registers the user in the organization defined in the "Onboarding Organization" action of the policy. By default, it is set to "Default Organization".
If the user specifies an organization which does not currently exist in the CentraSite registry, the policy creates the new organization, and registers the user in the new organization.

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 section Configuring the Email Server in the document Basic Operations.

The Global New User Account Policy has input parameters that you must set to enforce the user registration.

To configure the input parameters for Global New User Account Policy

Display the Global New User Account Policy Details page whose actions you want to configure. If you need procedures for this step, see Viewing or Changing a Policy.
On the Actions tab do the following:
1. Mandatory. To configure the Initiate Approval action, set the following parameters:
  - Mandatory. Approver Group: Specify the designated group of approvers.
  - Mandatory. Approval is needed from: Specify an approval mode "All" or "Anyone".
  Click Save to update the parameter settings.
2. For more information about configuring the Initiate Approval action, see the section Initiate Approval in the document Built-In Design/Change-Time Actions Reference.
3. To configure the Onboarding Organization action, set the following parameters:
  - Mandatory. Onboarding Organization: Specify the organization in which you want to register the user, when the requestor has not specified any organization. By default, "Default Organization".
  - Onboarding Success Message: Specify a notification template for the new user account success message. By default, "NewAccountSuccessMessage.html".
4. Click Save to update the parameter settings.

New User Account Policy

The "New User Account Policy" of an organization enables an automated registration of user for the particular organization.

The New User Account Policy has input parameters that you must set to enforce the user registration.

To configure the input parameters for New User Account Policy

Display the New User Account Policy Details page whose actions you want to configure. If you need procedures for this step, see Viewing or Changing a Policy.
On the Actions tab do the following:
1. On the Initiate Approval action, set the parameters:
  - Mandatory. Approver Group: Specify the designated group of approvers.
  - Mandatory. Approval is needed from: Specify an approval mode "All" or "Anyone".
  - Click Save to update the parameter settings.
2. On the Onboarding User action, set the parameters:
  - Onboarding Organization: Specify the organization in which you want to register the user. By default, "Default Organization".
  - Onboarding Success Message: Specify a notification template for the new user account success message. By default, "NewAccountSuccessMessage.html".
  - Click Save to update the parameter settings.

Consumer Onboarding Policies

CentraSite's approval-management framework enables you to configure policies that trigger approval processes when guest users (i.e. users without a valid CentraSite user account) try to access and register as consumers of APIs.

When users register as consumers for APIs (as described in Virtualizing APIs Using the CentraSite Business UI > Registering as Consumers for an API), the policy is triggered and the "User Registration" or an "Organization with User Registration" request is submitted to all members of the approval list specified in the "Initiate Approval" action. Then, the approvers can either approve or decline the request. If the approvers approve the request, the users will be registered as consumers, and appropriate permissions will be assigned to users.

To use the CentraSite's consumer-onboarding feature, you must configure the "Global Onboarding Policy" and every organization's "Consumer Onboarding Policy".

Note:
You do not need to explicitly activate the onboarding policies.

Global Onboarding Policy

The Global Onboarding Policy enables an automated onboarding to address the following scenarios:

If the user does not explicitly specify an organization, the policy onboards the user in the organization defined in the "Onboarding Organization" action of the policy. By default, it is set to "Default Organization".
If the user specifies an organization which does not currently exist in the CentraSite registry, the policy creates the new organization, and onboards the user in the new organization with an "Organization Administrator" role.

On successful onboarding of an user within the specified organization, CentraSite performs the API consumption process that has already been initiated.

The Global Onboarding Policy has input parameters that you must set to enforce the consumer onboarding.

To configure the input parameters for Global Onboarding Policy

Display the Global Onboarding Policy Details page whose actions you want to configure. If you need procedures for this step, see Viewing or Changing a Policy.
On the Actions tab do the following:
1. Mandatory. To configure the Initiate Approval action, set the following parameters:
  - Mandatory. Approver Group: Specify the designated group of approvers.
  - Mandatory. Approval is needed from: Specify an approval mode "All" or "Anyone".
  Click Save to update the parameter settings.
2. For more information about configuring the Initiate Approval action, see the section Initiate Approval in the document Built-In Design/Change-Time Actions Reference.
3. To configure the Onboarding Organization action, set the following parameters:
  - Mandatory. Onboarding Organization: Specify the organization to which you want to onboard the user as a consumer, when user requesting for an account has not specified any organization. By default, "Default Organization".
  - Onboarding Success Message: Specify a notification template for the consumer onboarding success message. By default, "OnboardingSuccessMessage.html".
4. Click Save to update the parameter settings.

Consumer Onboarding Policy

The "Consumer Onboarding Policy" of an organization enables an automated onboarding of user for that organization. On successful onboarding, performs the API consumption process that has already been initiated. If the API consumption includes an approval workflow, on approval, CentraSite generates the API key. On the other hand, if the API consumption does not include an approval workflow, CentraSite generates the API key immediately.

The Consumer Onboarding Policy has input parameters that you must set to enforce the consumer onboarding.

To configure the input parameters for Consumer Onboarding Policy

Display the Consumer Onboarding Policy Details page whose actions you want to configure. If you need procedures for this step, see Viewing or Changing a Policy.
On the Actions tab do the following:
1. On the Initiate Approval action, set the parameters:
  - Mandatory. Approver Group: Specify the designated group of approvers.
  - Mandatory. Approval is needed from: Specify an approval mode "All" or "Anyone".
  - Click Save to update the parameter settings.
2. On the Onboarding User action, set the parameters:
  - Onboarding Organization: Specify the organization to which you want to onboard the user as consumer. By default, "Default Organization".
  - Onboarding Success Message: Specify a notification template for the consumer onboarding success message. By default, "OnboardingSuccessMessage.html".
  - Click Save to update the parameter settings.

API Key Generation Policy

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 Virtualizing APIs Using the CentraSite Business UI > Registering as Consumers for an API), 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.

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

Initiate Approval

Initiates an approval workflow.

When this action is executed, CentraSite initiates the approval process. CentraSite will not process any subsequent actions in the policy or execute the requested operation until the approvals specified by the Initiate Approval action are received.

For more information about creating approval policies, see the section Working with Approval Workflows in the document Administering the CentraSite Business UI.

Input Parameters

`User`	String The user name that will be used together with the Password parameter as authentication credentials for performing a request on an API. The credentials are stored in the approval request and passed to the API for completing the approval. This parameter is only visible to users with the CentraSite Administrator role.
`Password`	String The password that will be used together with the User parameter as authentication credentials. This parameter is only visible to users with the CentraSite Administrator role.
`Approval Flow Name`	String The name to be given to the approval workflow that this action initiates. This name serves to identify the workflow in the approver's Pending Approvals. An approval flow name can contain any combination of characters, including a space. You can also include substitution tokens in the name to incorporate data from the target object on which the policy is acting. For a list of the allowed tokens, see the list of Substitution Tokens shown in the Send Email Notification action.
`Approver Group`	String Array The user group (or groups) that identifies the set of users who are authorized to approve the requested operation. Note: If the user groups specified in `Approver Group` are empty at enforcement time, the user's request is auto-approved.
`Approval is Needed From`	String The manner in which the approval is to be processed:
	Value	Description
	AnyOne	Default The request can be approved or rejected by any single user in `Approver Group`. In this mode, only one user from the set of authorized approvers is required to approve or reject the request.
	EveryOne	The request must be approved by all users specified in `Approver Group`. (It does not matter in which order the approvals are issued.) A single rejection will cause the request to be rejected.
`Reject State`	The lifecycle state that is to be assigned to the API if the approval request is rejected. If this parameter is not specified, the API's lifecycle state does not change when a rejection occurs. The lifecycle model must define a valid transition from the state that the target object is in at the time it is submitted for approval to the state specified in `Reject State`. Otherwise, the target object's state will not be switched when a rejection occurs. For more information about using this parameter, see the topic Switching the State of an Object when an Approval Request is Rejected in the section Working with Approval Workflows in the document Administering the CentraSite Business UI.
`Send Pending Approval Email`	Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is initially submitted for approval. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent. Note: If the request is auto-approved, this message is not sent. Note: CentraSite automatically sends the email message to the approvers in addition to the users and/or groups that you specify below.
	`Users`	Array of Users Users who are to receive the email. Note: You can specify the recipients of the email using the `Users` parameter, the `Groups` parameter, or both.
	`Groups`	Array of Groups Groups whose users are to receive the email. Note: CentraSite will only send the email to those users in the group whose CentraSite user account includes an email address.
	`Subject`	String The text that you want to appear in the subject line of the email. This text can include substitution tokens to insert run-time data into the subject line. For available tokens, see the list of Substitution Tokens shown in the Send Email Notification action.
	`Use Email Template`	Email Template Specifies the template that is to be used to generate the body of the email message. For more information about using email templates, see the topic Predefined Email Templates Installed with CentraSite in the section Working with Email Notifications . Note: You can use the predefined template, PendingNotification.html, for pending-approval notifications if you do not want to create an email template of your own. Note: If you use an email template to generate the body of the message, you cannot specify the body of the message using the `Custom Message` parameter. (In other words, you specify the body of the message using either the `Use Email Template` or the `Custom Message` parameter.)
	`Custom Message`	TextArea The text of the email message. This text can include substitution tokens to insert run-time data into the message. For available tokens, see the list of Substitution Tokens shown in the Send Email Notification action. Note: If you use the `Custom Message` parameter to specify the body of the email message, you cannot generate the body of the message using an email template. (In other words, you specify the body of the message using either the `Custom Message` or the `Use Email Template` parameter.)
	`Format`	String Specifies whether the message in the `Custom Message` parameter is formatted as HTML or plain text.
	`Include owner in notification`	Boolean When the parameter is enabled, CentraSite sends the email to the provider of the API (on which the policy is acting) in addition to the other recipients.
`Send Approval Email`	Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is approved. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent. Note: CentraSite automatically sends the email message to the user who submitted the approval request in addition to the users and/or groups that you specify below. Note: When the EveryOne option is specified in the `Approval is Needed From` parameter, CentraSite sends this email only after all approvers have approved the request.
	`Users`	See description of `Users` parameter above.
	`Groups`	See description of `Groups` parameter above.
	`Subject`	See description of `Subject` parameter above.
	`Use Email Template`	See description of `Use Email Template` parameter above. Note: You can use the predefined template, ApprovalNotification.html, for approval notifications if you do not want to create an email template of your own.
	`Custom Message`	See description of `Custom Message` parameter above.
	`Format`	See description of `Format` parameter above.
	`Include owner in notification`	See description of `Include owner in notification` parameter above.
`Send Rejection Email`	Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is rejected. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent. Note: CentraSite automatically sends the email message to the approvers (except for the approver who rejected the request) and to the user who submitted the approval request in addition to the users and/or groups that you specify below.
	`Users`	See description of `Users` parameter above.
	`Groups`	See description of `Groups` parameter above.
	`Subject`	See description of `Subject` parameter above.
	`Use Email Template`	See description of `Use Email Template` parameter above. Note: You can use the predefined template, RejectApprovalNotification.html, for rejection notifications if you do not want to create an email template of your own.
	`Custom Message`	See description of `Custom Message` parameter above.
	`Format`	See description of `Format` parameter above.
	`Include owner in notification`	See description of `Include owner in notification` parameter above.

API Key Generator

Generates an API key for the API.

Input Parameters

Key Expiration Interval String. Mandatory. Specifies the time interval an API key can remain active. When the interval expires, the current key is marked expired.

Deploy API Key

Initiates an API key deployment in the target (for example, Mediator).

Note:
If the target 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 users and/or groups.

Note:
During an iteration of the policy, if the connection to a SMTP email server fails, this policy action returns a failure code. CentraSite writes the failure message to the policy log; however performs the next action in the policy (if one exists).

Input Parameters

`Users`	Array of Users Users who are to receive the email. Note: You can specify the recipients of the email using the `Users` parameter, the `Groups` parameter, or both.
`Groups`	Array of Groups Groups whose users are to receive the email. Note: CentraSite will only send the email to those users in the group whose CentraSite user account includes an email address.
`Subject`	String The text that you want to appear in the email's subject line. This text can include substitution tokens to insert run-time data into the subject line. For information about using substitution tokens, see Substitution Tokens, below.
`Use Email Template`	Email Template Specifies the template that is to be used to generate the body of the email message. For more information about using email templates, see the topic Predefined Email Templates Installed with CentraSite in the section Working with EMail Notifications . Note: You can use the predefined template, NotifyAPIKeyGenerationToConsumer.html, as your email template if you do not want to create an email template of your own. Note: If you use an email template to generate the body of the message, you cannot specify the body of the message using the `Custom Message` parameter. (In other words, you specify the body of the message using either the `Use Email Template` or the `Custom Message` parameter.)
`Custom Message`	TextArea The text of the email message. This text can include substitution tokens to insert run-time data into the message. For information about using substitution tokens, see Substitution Tokens, below. Note: If you use the `Custom Message` parameter to specify the body of the email message, you cannot generate the body of the message using an email template. (In other words, you specify the body of the message using either the `Custom Message` or the `Use Email Template` parameter.)
`Format`	String Specifies whether the custom mail message is formatted as HTML or plain text.
`Include owner in notification`	Boolean When enabled, this parameter sends the email notification to the provider of the API on which the policy is acting in addition to the users specified by the `Users` and `Groups` parameters.

API Key Renewal Policy

After an API key is generated, users sometimes want to renew the old key due to expiration or security concerns. API Consumers can re-generate/renew API keys to change the default expiration time of an API key, consumer of an API generates the API key which serves as an authentication token when the consumer requests for consumption of the API.

When a consumer requests for renewing an API key (as described in Renewing API Keys), CentraSite internally creates and triggers an API Key Renewal policy for the API. A request for the API key renewal 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 re-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 newly generated key.

The following actions are typically used with the API Key Renewal policy.

The Initiate Approval action is generally used to obtain necessary approvals for a consumer prior to executing the Renew API Key action.
The Renew API Key action is used to re-define the default expiration interval of an API key, and re-generate the API key for the API.
The Deploy API Key is typically executed after the Renew API Key action to redeploy the newly generated key in the Mediator.
The Create Auditable Events action is used to capture the audit logs in changing the validity of the API key.
The Send Email Notification action is used to send an email message to the API consumer with details of the new validity of API key.

Object Scope

API Key

Event Scope

On-Trigger

Initiate Approval

Initiates an approval workflow.

For more information about creating approval policies, see the section Working with Approval Workflows in the document Administering the CentraSite Business UI.

Input Parameters

`User`	String The user name that will be used together with the Password parameter as authentication credentials for performing a request on an API. The credentials are stored in the approval request and passed to the API for completing the approval. This parameter is only visible to users with the CentraSite Administrator role.
`Password`	String The password that will be used together with the User parameter as authentication credentials. This parameter is only visible to users with the CentraSite Administrator role.
`Approval Flow Name`	String The name to be given to the approval workflow that this action initiates. This name serves to identify the workflow in the approver's Pending Approvals. An approval flow name can contain any combination of characters, including a space. You can also include substitution tokens in the name to incorporate data from the target object on which the policy is acting. For a list of the allowed tokens, see the list of Substitution Tokens shown in the Send Email Notification action.
`Approver Group`	String Array The user group (or groups) that identifies the set of users who are authorized to approve the requested operation. Note: If the user groups specified in `Approver Group` are empty at enforcement time, the user's request is auto-approved.
`Approval is Needed From`	String The manner in which the approval is to be processed:
	Value	Description
	AnyOne	Default The request can be approved or rejected by any single user in `Approver Group`. In this mode, only one user from the set of authorized approvers is required to approve or reject the request.
	EveryOne	The request must be approved by all users specified in `Approver Group`. (It does not matter in which order the approvals are issued.) A single rejection will cause the request to be rejected.
`Reject State`	The lifecycle state that is to be assigned to the API if the approval request is rejected. If this parameter is not specified, the API's lifecycle state does not change when a rejection occurs. The lifecycle model must define a valid transition from the state that the target object is in at the time it is submitted for approval to the state specified in `Reject State`. Otherwise, the target object's state will not be switched when a rejection occurs. For more information about using this parameter, see the topic Switching the State of an Object when an Approval Request is Rejected in the section Working with Approval Workflows in the document Administering the CentraSite Business UI.
`Send Pending Approval Email`	Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is initially submitted for approval. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent. Note: If the request is auto-approved, this message is not sent. Note: CentraSite automatically sends the email message to the approvers in addition to the users and/or groups that you specify below.
	`Users`	Array of Users Users who are to receive the email. Note: You can specify the recipients of the email using the `Users` parameter, the `Groups` parameter, or both.
	`Groups`	Array of Groups Groups whose users are to receive the email. Note: CentraSite will only send the email to those users in the group whose CentraSite user account includes an email address.
	`Subject`	String The text that you want to appear in the subject line of the email. This text can include substitution tokens to insert run-time data into the subject line. For available tokens, see the list of Substitution Tokens shown in the Send Email Notification action.
	`Use Email Template`	Email Template Specifies the template that is to be used to generate the body of the email message. For more information about using email templates, see the topic Predefined Email Templates Installed with CentraSite in the section Working with Email Notifications . Note: You can use the predefined template, PendingNotification.html, for pending-approval notifications if you do not want to create an email template of your own. Note: If you use an email template to generate the body of the message, you cannot specify the body of the message using the `Custom Message` parameter. (In other words, you specify the body of the message using either the `Use Email Template` or the `Custom Message` parameter.)
	`Custom Message`	TextArea The text of the email message. This text can include substitution tokens to insert run-time data into the message. For available tokens, see the list of Substitution Tokens shown in the Send Email Notification action. Note: If you use the `Custom Message` parameter to specify the body of the email message, you cannot generate the body of the message using an email template. (In other words, you specify the body of the message using either the `Custom Message` or the `Use Email Template` parameter.)
	`Format`	String Specifies whether the message in the `Custom Message` parameter is formatted as HTML or plain text.
	`Include owner in notification`	Boolean When the parameter is enabled, CentraSite sends the email to the provider of the API (on which the policy is acting) in addition to the other recipients.
`Send Approval Email`	Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is approved. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent. Note: CentraSite automatically sends the email message to the user who submitted the approval request in addition to the users and/or groups that you specify below. Note: When the EveryOne option is specified in the `Approval is Needed From` parameter, CentraSite sends this email only after all approvers have approved the request.
	`Users`	See description of `Users` parameter above.
	`Groups`	See description of `Groups` parameter above.
	`Subject`	See description of `Subject` parameter above.
	`Use Email Template`	See description of `Use Email Template` parameter above. Note: You can use the predefined template, ApprovalNotification.html, for approval notifications if you do not want to create an email template of your own.
	`Custom Message`	See description of `Custom Message` parameter above.
	`Format`	See description of `Format` parameter above.
	`Include owner in notification`	See description of `Include owner in notification` parameter above.
`Send Rejection Email`	Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is rejected. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent. Note: CentraSite automatically sends the email message to the approvers (except for the approver who rejected the request) and to the user who submitted the approval request in addition to the users and/or groups that you specify below.
	`Users`	See description of `Users` parameter above.
	`Groups`	See description of `Groups` parameter above.
	`Subject`	See description of `Subject` parameter above.
	`Use Email Template`	See description of `Use Email Template` parameter above. Note: You can use the predefined template, RejectApprovalNotification.html, for rejection notifications if you do not want to create an email template of your own.
	`Custom Message`	See description of `Custom Message` parameter above.
	`Format`	See description of `Format` parameter above.
	`Include owner in notification`	See description of `Include owner in notification` parameter above.

Renew API Key

Re-generates an API key with new validity for the API.

Input Parameters

Key Expiration Interval String. Mandatory. Specifies the new time interval a re-generated API key can remain active. When the interval expires, the current key is marked expired.

Deploy API Key

Re-deploys the API key with new validity in the target (for example, Mediator).

Note:
The action is prone to failure due to the fact that the target may be down/unreachable. In case of failure, the API Provider is intimated through the configured email. For example, if an API key is already deployed in multiple targets and upon API key renewal, re-deployment fails in a couple of targets, a mail would be sent to API Provider informing that the API key deployment failed in the listed targets. Currently, API Provider is not allowed to deploy an API key alone. Instead, the Provider has to redeploy the API to deploy the updated key (after taking corrective actions in mediator).

Input Parameters

Create Auditable Events

Creates an audit log for changing the default expiration interval of the API key.

Input Parameters

`Context Key`	String. Mandatory.
`Context Value`	String. Mandatory.

Send Email Notification

Sends an email message to specified users and/or groups.

Note:
To use this action, 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 section Configuring the Email Server in the document Administrator-Level Configuration Tasks.

Input Parameters

`Users`	Array of Users Users who are to receive the email. Note: You can specify the recipients of the email using the `Users` parameter, the `Groups` parameter, or both.
`Groups`	Array of Groups Groups whose users are to receive the email. Note: CentraSite will only send the email to those users in the group whose CentraSite user account includes an email address.
`Subject`	String The text that you want to appear in the email's subject line. This text can include substitution tokens to insert run-time data into the subject line. For information about using substitution tokens, see Substitution Tokens, below.
`Use Email Template`	Email Template Specifies the template that is to be used to generate the body of the email message. For more information about using email templates, see the topic Predefined Email Templates Installed with CentraSite in the section Working with EMail Notifications . Note: You can use the predefined template, NotifyAPIKeyGenerationToConsumer.html, as your email template if you do not want to create an email template of your own. Note: If you use an email template to generate the body of the message, you cannot specify the body of the message using the `Custom Message` parameter. (In other words, you specify the body of the message using either the `Use Email Template` or the `Custom Message` parameter.)
`Custom Message`	TextArea The text of the email message. This text can include substitution tokens to insert run-time data into the message. For information about using substitution tokens, see Substitution Tokens, below. Note: If you use the `Custom Message` parameter to specify the body of the email message, you cannot generate the body of the message using an email template. (In other words, you specify the body of the message using either the `Custom Message` or the `Use Email Template` parameter.)
`Format`	String Specifies whether the custom mail message is formatted as HTML or plain text.
`Include owner in notification`	Boolean When enabled, this parameter sends the email notification to the provider of the API on which the policy is acting in addition to the users specified by the `Users` and `Groups` parameters.

API Key Revocation Policy

After an API key is generated, users sometimes want to revoke the key in case of malfunction. API Provider can revoke API keys to disable access to an API subscribed by a consumer.

When a provider requests for revocation of an API key (as described in Revoking API Keys), CentraSite internally creates and triggers an API Key Revoke policy for the API. A request for the key revocation 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 revokes the API key, and notifies the consumer that the API is now unavailable for consumption.

The following actions are typically used with the API Key Revocation policy.

The Revoke API Key action is used to revoke an API key for the API.
The Create Auditable Events action is used to capture the audit logs in revoking the API key.
The Send Email Notification action is used to send an email message to the API consumer about revocation of the API key.

Object Scope

API Key

Event Scope

On-Trigger

Revoke API Key

Revokes an existing key for the API.

Input Parameters

None.

Create Auditable Events

Creates an audit log for revoking the API key.

Input Parameters

`Context Key`	String. Mandatory.
`Context Value`	String. Mandatory.

Send Email Notification

Sends an email message to specified users and/or groups.

Input Parameters

`Users`	Array of Users Users who are to receive the email. Note: You can specify the recipients of the email using the `Users` parameter, the `Groups` parameter, or both.
`Groups`	Array of Groups Groups whose users are to receive the email. Note: CentraSite will only send the email to those users in the group whose CentraSite user account includes an email address.
`Subject`	String The text that you want to appear in the email's subject line. This text can include substitution tokens to insert run-time data into the subject line. For information about using substitution tokens, see Substitution Tokens, below.
`Use Email Template`	Email Template Specifies the template that is to be used to generate the body of the email message. For more information about using email templates, see the topic Predefined Email Templates Installed with CentraSite in the section Working with EMail Notifications . Note: You can use the predefined template, NotifyAPIKeyGenerationToConsumer.html, as your email template if you do not want to create an email template of your own. Note: If you use an email template to generate the body of the message, you cannot specify the body of the message using the `Custom Message` parameter. (In other words, you specify the body of the message using either the `Use Email Template` or the `Custom Message` parameter.)
`Custom Message`	TextArea The text of the email message. This text can include substitution tokens to insert run-time data into the message. For information about using substitution tokens, see Substitution Tokens, below. Note: If you use the `Custom Message` parameter to specify the body of the email message, you cannot generate the body of the message using an email template. (In other words, you specify the body of the message using either the `Custom Message` or the `Use Email Template` parameter.)
`Format`	String Specifies whether the custom mail message is formatted as HTML or plain text.
`Include owner in notification`	Boolean When enabled, this parameter sends the email notification to the provider of the API on which the policy is acting in addition to the users specified by the `Users` and `Groups` parameters.

SEARCH CONTENTS | PDF BOOKS | HOME UP PREV NEXT