Submit requests
post
/iam/governance/selfservice/api/v1/requests
Submits new request(s). At a given time a request of one type can be supported for example provisioning request cannot be clubbed with a create or modify user request. Provisioning request can include different entities namely application instance, entitlement and role.
Request
Supported Media Types
- application/json
List of attributes of request to be raised. The supported values for entity type is "AppInstance, Entitlement and Role". The "parentAccountId" attribute is consumed only for entity type Entitlement. The account ID mentioned will be used for associating the entitlement to the provided account. If no parent account ID is provided for entity type entitlement then the Primary Account will be associated with the requested entitlement.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
403 Response
Forbidden
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example demonstrates the ability for bulk operation of the creating of requests. It shows both success and failure. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X POST -u username:password -d @post.json https://pseudo.com/iam/governance/selfservice/api/v1/requests
Example of POST Request Body
The following shows the contents of the request body in JSON format.
{
"requests": [
{
"requestId": "Req1001",
"reqJustification": "Requesting for application",
"reqBeneficiaryList": [
{
"id": "2007"
}
],
"reqTargetEntities": [
{
"entityId": "1",
"entityType": "appInstance",
"appFormData": [
{
"name": "Account Login",
"value": "test24"
},
{
"name": "Password",
"value": "Test@3"
},
{
"name": "ID",
"value": "test24@email.com"
}
]
}
]
},
{
"requestId": "Req1002",
"reqJustification": "Requesting for application",
"reqTargetEntities": [
{
"entityId": "1",
"entityType": "appInstance"
}
]
}
]
}
Example of POST Response Body
The following example shows the contents of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests"
}
],
"requests": [
{
"requestId": "Req1001",
"status": "FAIL",
"reason": "Invalid appForm field provided."
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/5048"
}
],
"id": "5048",
"requestId": "Req1002",
"reqStatus": "PENDING",
"status": "SUCCESS"
}
]
}