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 request to consume APIs (as described in Requesting an API for Consumption), 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 "User Onboarding Policy".
Note:
You do not need to explicitly activate the onboarding
policies.
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:
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.
For more information about configuring the Initiate Approval action, see the section Initiate Approval in the document Built-In Design/Change-Time Actions Reference.
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".
Click Save to update the parameter settings.
The "User 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 User Onboarding Policy has input parameters that you must set to enforce the consumer onboarding.
To configure the input parameters for User Onboarding Policy
Display the User 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:
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.
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.