1. REST API for Oracle Identity Governance Self Service
  2. Tasks
  3. Request

Submit Requests

post

/iam/governance/selfservice/api/v1/requests

Submits new request(s). Provisioning request can include different entities namely application instance, entitlement and role. Note that optional sunrise and sunset dates can be included in the request using the startDate and endDate attributes.

Request

Supported Media Types
Body ()
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.
Root Schema : BulkReqCreateRequest
Type: object
Show Source
Nested Schema : requests
Type: array
Show Source
Nested Schema : ReqCreateRequestEntity
Type: object
Show Source
Nested Schema : reqBeneficiaryList
Type: array
Show Source
Nested Schema : reqTargetEntities
Type: array
Show Source
Nested Schema : RequestBeneficiaryPost
Type: object
Show Source
Nested Schema : reqTargetEntityPost
Type: object
Show Source
Nested Schema : Attributes
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful
Headers
Body ()
Root Schema : BulkReqCreateResponse
Type: object
Show Source
Nested Schema : requests
Type: array
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source
Nested Schema : ReqCreateResponseEntity
Type: object
Show Source

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal Server Error

Default Response

Unexpected error
Back to Top

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"  -H "X-Requested-By: <anyvalue>"  -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" : "Request role for sub-ordinate",
			"reqBeneficiaryList":
			[
				{
					"id": "24"
				}
			],
			"reqTargetEntities":
			[
				{
					"entityId": "12",
					"entityType": "role",
					"startDate" : "2019-03-19T01:30:00Z",
					"endDate" : "2019-09-25T18:30:00Z"
				},
				{
					"entityId": "13",
					"entityType": "role",
					"startDate" : "2019-03-19T01:30:00Z",
					"endDate" : "2019-09-25T18:30:00Z"
				}
			]
		}
	]
}

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": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/3"
                }
            ],
            "id": "3",
            "requestId": "Req1001",
            "reqStatus": "Request Created",
            "status": "SUCCESS"
        }
    ]
}

Example Request for Revoking Entitlement

The following shows the contents of the request body in JSON format.

{
"requests": [
    {
      "id": "7001",
      "reqJustification": "Request Entitlement",
      "operation" : "revoke",
      "reqBeneficiaryList": [
        {
          "id": "6"
        }
      ],
      "reqTargetEntities": [
        {
          "entityId": "246",
          "entityType": "Entitlement"
        }
      ]
    }
  ]
}
Back to Top