SOA Governance and 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
Parameters
Description
Active user approver group
Endpoint:
http://host:port
/abs/apirepository/configur
ations/com.aris.umc.apiport
al.useronboarding.approval
.approvergroup/
Method: POST
Request Body: New approver group name
Create an Active new User Registration Approvers group.:
Sample Request:
Endpoint:
http://your serverg/a
bs/apirepository/configurations/com
.aris.umc.apiportal.useronboarding.
approval.approvergroup/
Method: POST
Request Body: Approvers
Onboarding request token
Endpoint:
http://host:port
/abs/apirepository/configur
ations/com.aris.umc.apiport
al.useronboarding.validatee
mail.token.ttl/
Method: POST
Request Body: New expiration period
in minutes

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/a
bs/apirepository/configurations/com
.aris.umc.apiportal.useronboarding
.validateemail.token.ttl/
Method: POST
Request Body: 60
Data purging
Endpoint:
http://host:port
/abs/apirepository/configur
ations/com.aris.umc.apiport
al.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
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 will be deleted after the requester is approved or rejected.
By this time, the token, which we see in the URL, will also be 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