Configuring Approvals for Registering Application
You have to configure the approval settings, to enforce approval for associating an application with APIs in API Gateway. The API Portal API get access token request is considered as a create and registering application event in API Gateway.
To configure approvals for registering an application
1. Select Username > Administration.
2. Select General > Register application.
3. Set the Enable toggle button to the on position to enable approval configuration to take effect.
4. Select the access profile of approvers from the Approvers drop-down list.
5. Select the anyone from the Approved by drop-down list.
This implies that, any one user associated with the approvers access profile can approve or reject the requests. The requester need not wait for the approval of each approver in the approvers group.
Note: If a user is associated with the Administrators access profile, then the user can approve or reject a pending request even if the user is not associated with the Approvers group.
6. Select Configure approval initiate request mail template to be sent to approver.
This is to configure the email template to be sent to the approver for associating an application with APIs.
7. Provide the following information in the Configure approval initiate request mail template to be sent to approve section:
Field | Description |
Send notification | To send an email notification to the approver to approve the request for associating an application with APIs. |
Subject | The subject line of the email to be sent. |
Content | By default, the template appears. You can customize the email content. Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Hello @approver.name appears as Hello Joe in the email sent, where Joe is the approvers login ID. |
Note: The email notifications are sent only to the local API Gateway users.
8. Select Configure request approved mail template to be sent to requester.
This is to configure the email template to be sent to the requester to notify that the request for associating an application with APIs is approved.
9. Provide the following information in the Configure request approved mail template to be sent to requester section:
Field | Description |
Send notification | To send an email notification to the requester that the request for associating an application with APIs is approved by the approver. |
Subject | The subject line of the email to be sent. |
Content | By default, the template appears. You can customize the email content. Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Approval of @event.type appears as Approval of Register Application in the email sent, where Register Application is the event.type. |
10. Select Configure rejection mail template to be sent to requester.
This is to configure the email template to be sent to the requester to notify that the request for registering an application is rejected.
11. Provide the following information in the Configure rejection mail template to be sent to requester section:
Field | Description |
Send notification | To send an email notification to the requester that the request for associating an application with APIs is rejected by the approver. |
Subject | The subject line of the email to be sent. |
Content | By default, the template appears. You can customize the email content. Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Approval of @event.type appears as Approval of Register Application in the email sent, where Register Application is the event.type. |
12. Click Cancel to revert to the last saved changes or to abandon all the changes if the values are not saved.
13. Click Save.