If you are the CentraSite Administrator, an API provider or a designated approver, CentraSite places requests for your review and approval.
This section details on how to review and approve the API related requests.
The onboarding requests for a user or an organization with user is tracked in the following ways:
If the user has specified an existing organization in the CentraSite registry, the Consumer Onboarding request is visible in the details page of the organization that is configured in the specified organization's "Consumer Onboarding" policy.
If the user has specified an organization that does not exist in the CentraSite registry, the organization with Consumer Onboarding request is visible in the Default Organization's details page.
If the user has not specified any organization, the Consumer Onboarding request is visible in the details page of the organization that is configured in the "Global Onboarding" policy.
Users with the "Manage Organizations" system-level permission (such as the users with the role "CentraSite Administrator") can view and approve onboarding requests for any organization. Users with the "Organization Administrator" organization-level role for a given organization can perform view and approve onboarding requests on that organization.
To view and approve consumer registration requests
In CentraSite Business UI, display the details page for the organization whose user registration request you want to review and approve.
You will see the pending user registration requests () in the
description area of the Basic Information profile, for
example, "N user registration requests are
pending
”.
If there are no pending approval requests for the organization, this
is displayed as “0
".
Click the hyperlinked number (“N
”) to
open the Pending User Registration Requests dialog. This
dialog contains a list of all requests that have been submitted for the
particular organization, including requests that were auto-approved.
Choose the user registration request that you want to review and approve by clicking its hyperlinked name.
The details for the request will appear in the User Registration Requests dialog.
In the Comment text box, type a comment. (e.g., "Request rejected. Add required specifications to this user and resubmit".)
Click the
or button as appropriate to approve or reject the request.When a user submits an API request that requires an approval, CentraSite initiates an approval workflow and submits the user’s request to both the API provider and designated group of approvers.
Approvers receive the approval requests in the API details page in CentraSite Business UI. Approvers whose user account includes a valid email address also receive an email message informing them that a request is awaiting their approval.
CentraSite does not process an API request until it obtains the necessary approvals. If an approver rejects the request, CentraSite notifies the requestor and ignores further processing.
The following requests for API key management can trigger an approval workflow:
Generating an API Key / OAuth Token
Renewing an API Key
Revoking an API Key
Note:
For CentraSite to issue email messages, an administrator must first configure CentraSite's email server settings. For procedures,
see the section Configuring the Email Server in the document Basic Operations.
Important:
Points to consider when approving or rejecting an API key request for consumption:
If the user who makes an API request is also an authorized approver for the action, the request is auto-approved. (In other words, the requestor's approval is granted implicitly.)
If an API provider has configured the Require Approval option in the API Consumption Settings for "Anyone" approval mode, only one user in the group is required to approve or reject the request. This is the default mode.
If an API provider has configured for the "All" approval mode, the request must be approved by all users in the approver group (it does not matter in which order the approvals are obtained). A rejection by any approver in the group will cause the request to be rejected.
To view and approve consumer registration requests
In CentraSite Business UI, display the details page for the API whose request you want to review and approve.
You will see the pending approval requests () for an API in the description area of the Basic Information profile,
for example, "N number of pending approvals
”.
If there are no pending approval requests for the API, this is
displayed as “0
".
Click the hyperlinked number (“N
”) to
open the Pending Approval Requests dialog. This dialog
contains a list of requests that have been submitted for the
particular API, including requests that were auto-approved.
Choose the API request that you want to review and approve by clicking its hyperlinked name.
The details for the request will appear in the API Request dialog.
In the Comment text box, type a comment. (e.g., "Request rejected. Add required specifications to this asset and resubmit".)
Click the
or button as appropriate to approve or reject the request.