API Management : Administering API Portal : Configuring API-Portal : Advanced Configuration of API-Portal
Advanced Configuration of API-Portal
Some user registration parameters are configurable by a REST service. To configure user registration parameters using a REST service, you must have API Administrator privileges. Any REST client tool can be used to invoke the mentioned APIs.
REST Resource: Active user approver group
Parameters:
*Endpoint: http://host:port/abs/apirepository/configurations/com.aris.umc.apiportal.userboarding.approval.approvergroup/
*Method: POST
*Request body: New expiration period in minutes
Description: Create an Active new User Registration Approvers group.
Sample request
*Endpoint: http://your server/abs/apirepository/configurations/com.aris.umc.apiportal.useronboarding.approval.approvergroup/
*Method: POST
*Request body: Approvers
REST Resource: Onboarding request token
Parameters:
*Endpoint: http://host:port/abs/apirepository/configurations/com.aris.umc.apiportal.useronboarding.validateemail.token.ttl/
*Method: POST
*Request Body: New expiration period in minutes
Description: REST Service to change the expiration period of the link generated during email confirmation workflow. The default value is 30 minutes.
Sample request
*Endpoint: http://your server/abs/apirepository/configurations/com.aris.umc.apiportal.useronboarding.validateemail.token.ttl/
*Method: POST
*Request Body: 60
REST Resource: Data purging
Parameters:
*Endpoint: http://host:port/abs/apirepository/configurations/com.aris.umc.apiportal.useronboarding.approval.purge/
*Method: POST
*Request body: true|false
*Endpoint: true|http://host:port/abs/ apirepository/purge/false
*Method: DELETE
*Sample request payload:
{"purgeSettings":[{"objectTyp e":"User",
"until":"2014-11-29 T00:00:00"},
{"objectType": "Approval", "until":"2014-11-29T00:00:00"}]}
*Expected response code is 204
Description: REST Service to modify the default purging behavior for the approval objects. The default value is true. If the value is set to false, the API Administrator must perform manual purging. Metadata for pending approvals is deleted after the requester is approved or rejected. By this time, the token, which we see in the URL, is also deleted. API-Portal cannot differentiate between an invalid token (any token entered by the requester) and a valid, but expired, token (which is deleted by the first request).
Sample request
*Endpoint: http://your server/abs/apirep ository/configurations/com.aris.umc.apiportal.useronboarding.approval.purge/
*Method: POST
*Request body: false
The expected HTTP response code for all REST resources listed in the table is 202.
Copyright © 2015- 2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback