Using Approvals with OnTrigger Events
The OnTrigger event occurs when an Organization Administrator reviews a consumer (user) registration request and accepts the request by clicking the "pending user registrations requests" in the organization's Basic Information profile.
An organization must have a consumer-onboarding policy to process the consumer registrations that are initiated using the Consume action. At a minimum, this policy must include the Create User and Consume API actions, because these actions perform the work of actually registering a user as consumer and establishing the actual relationship between the API and the specified consumers). If, in addition to the API owner, you want designated individuals to review and approve the registration request, place an approval action before the Create User action.
Note: | The approval process that is imposed by a consumer-onboarding policy occurs in addition to the review and approval that is required by the Organization Administrator. That is, the Organization Administrator always reviews the registration first, and if he or she accepts the registration, the request proceeds through the approval process defined by the consumer-onboarding policy. |
The following procedure describes the general steps you use to create a consumer-onboarding policy that includes an approval action.
1. Create a design/change-time policy with the following scope:
Event Type: OnTrigger
Object Type: Asset (Service, Organization)
If you need procedures for this step, see the CentraSite User’s Guide.
2. On the policy's Actions tab, do one of the following.
Note: | Make sure the approval action precedes the operation-specific actions. |
If the object type "Organization" is selected, choose the following actions.
i. Initiate Approval
ii. Onboarding Organization —OR— Onboarding User
If the object type "Service" is selected, choose the following actions.
i. Initiate Approval
ii. Onboarding Organization —OR— Onboarding User
iii. Onboarding Consume API
3. Configure the approval action's input parameters.
4. Insert additional actions before and/or after this pair of actions as necessary.
The following example shows an action list that obtains the required approval, executes the registration process, and then grants the API for consumption to the consumers that the policy registers.
Initiate Approval
Onboarding User
Onboarding Consume API
