1. Oracle Access Governance REST APIs
  2. Tasks
  3. AccessRequests

Create an Access Request

post

/access-governance/access-controls/20250331/accessRequests

Creates a new access request for an identity with the specified details. You can create an Access Request only for Workforce Identities.

Request

Header Parameters
  • The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Body ()
Details for the new Access Request
Root Schema : CreateAccessRequestDetails
Type: object
The information about new AccessRequest.
Show Source
Nested Schema : accessBundles
Type: array
list of Access bundle items.
Show Source
Nested Schema : accessLimitDataDetails
Type: array
List of access limit data associated to permission request
Show Source
Nested Schema : accountProfileDetails
Type: array
List of account profiles associated to access request. Required only if the associated access bundle has Account Profile attached to it.
Show Source
Nested Schema : attributes
Type: object
Additional Properties Allowed
Show Source
Attributes of the corresponding model. Example: `{"foo-namespace": {"bar-key": "value"}}`
Nested Schema : identities
Type: array
list of identity ids
Show Source
Nested Schema : orchestratedSystemAttributes
Type: array
list of orchestratedSystemAttributes associated with targets
Show Source
Nested Schema : permissionRoles
Type: array
list of Permission roles items.
Show Source
Nested Schema : AccessLimitDataDetails
Type: object
Access Limit Data configured by Identity
Show Source
Nested Schema : AccessLimitDataInfo
Type: object
Access Limit Data information object.
Show Source
Nested Schema : identityAccessLimitDetails
Type: array
Access Limit Data for Identity
Show Source
Nested Schema : AccessLimitData
Type: object
The Temporal Access Bundle data.
Show Source
Nested Schema : AccessLimitDateTimeConfig
Type: object
The Temporal Access Bundle data for date time.
Show Source
Nested Schema : AccessLimitDaysConfig
Type: object
The Temporal Access Bundle data for days.
Show Source
Nested Schema : AccessLimitHoursConfig
Type: object
The Temporal Access Bundle data for hours.
Show Source
Nested Schema : IdInfo
Type: object
Generic identifying information object.
Show Source
Nested Schema : IdentityAccessLimitDataInfo
Type: object
Access Limit Data for Identity
Show Source
Nested Schema : AccountProfileInfo
Type: object
Account Profile Configuration by Identity
Show Source
Nested Schema : accountAttributes
Type: array
Account Attribute Values
Show Source
Nested Schema : identityAccountAttributesDetails
Type: array
Account Attributes Info by Identity
Show Source
Nested Schema : QuestionAttributeDataSummary
Type: object
Question Attributes of account profile
Show Source
Nested Schema : children
Type: array
nested attributes
Show Source
Nested Schema : values
Type: array
Attribute Values
Show Source
Nested Schema : NestedQuestionAttributeSummary
Type: object
Nested set of question attributes
Show Source
Nested Schema : items
Type: array
Question attributes
Show Source
Nested Schema : IdentityAccountAttributesInfo
Type: object
Account Profile Attributes
Show Source
Nested Schema : accountAttributes
Type: array
Account Attribute Values
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : OrchestratedSystemAttribute
Type: object
Account & permission attributes
Show Source
Nested Schema : accountAttributes
Type: array
List of Orchestrated System account attributes
Show Source
Nested Schema : Info
Type: object
Generic information object.
Show Source
Nested Schema : permissionAttributes
Type: array
List of Orchestrated System permission attributes
Show Source
Nested Schema : OrchestratedSystemAttributeData
Type: object
Orchestrated System Attributes
Show Source
Nested Schema : children
Type: array
nested attributes
Show Source
Nested Schema : defaultValues
Type: array
Attribute Value
Show Source
Nested Schema : NestedAttributes
Type: object
Nested set of Orchestrated System attributes
Show Source
Nested Schema : items
Type: array
Orchestrated System attributes
Show Source
Back to Top

Response

Supported Media Types

200 Response

The newly created Access Request
Headers
  • For optimistic concurrency control. See `if-match`.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : AccessRequest
Type: object
Description of AccessRequest.
Show Source
Nested Schema : accessBundles
Type: array
list of Access bundle items.
Show Source
Nested Schema : approvalRequests
Type: array
List of approval requests created as part of the access request
Show Source
Nested Schema : attributes
Type: object
Additional Properties Allowed
Show Source
Attributes of the corresponding model. Example: `{"foo-namespace": {"bar-key": "value"}}`
Nested Schema : identities
Type: array
list of identities
Show Source
Nested Schema : permissionRoles
Type: array
list of Permission roles items.
Show Source
Nested Schema : AccessBundleInfo
Type: object
Generic information object.
Show Source
Nested Schema : ApprovalRequest
Type: object
Details of an Approval Request.
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : Info
Type: object
Generic information object.
Show Source

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

409 Response

Conflict
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source
Back to Top

Examples

The following example shows how to create a new access request. In a single access request, you can request multiple access bundles for multiple identities.

You must have Access Bundle ID, Identities ID, Account Profile ID and details, along with Account Attributes details. In this example, we will use the same question value for all identities.

Replace placeholder values with actual values before running the sample command.

cURL Request Example

curl -i -X POST \
   -H "Authorization:Bearer <your access token>" \
   -H "Content-Type:application/json" \
   -d \
'{
    "justification": "Sample Request Access", 
    "createdBy": "globalId.125xxx3c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b2xxxxxaa046b3ceb16a", 
    "accessBundles": ["6adcbc8d-1816-44a7-af70-78c40bf850fb"],
    "identities": ["globalId.OCI.bd49ff2a-5c47-4242-8975-9ba235fbb0ec.9fxxxxxxx69c2af598b63d4"],
    "accountProfileDetails": [
        {
            "accountProfileId": "84321700-1a93-4cf2-9226-3f4xxxxx68",
            "identitySpecific": false,
            "accountAttributes": [
                {
                    "name": "defaultTablespaceQuotaInMB",
                    "values": [
                        "100"
                    ],
                    "children": [],
                    "isQuestion": true
                }
            ]
        }
    ]
}' \
 '${service-instance-url}/access-governance/access-controls/20250331/accessRequests'

Example Request Payload

{
 "justification": "Sample Request Access",
 "createdBy": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20xxxxxxaa046b3ceb16a",
 "accessBundles": [
 "6adcbc8d-1816-44a7-af70-7xxxxxf850fb"
 ],
 "identities": [
 "globalId.OCI.bd49ff2a-5c47-4242-8975-9ba235fbb0ec.9f6exxxxx4960469c2af598b63d4"
 ],
 "accountProfileDetails": [
 {
 "accountProfileId": "8432xx700-1a93-4cf2-9226-3fxxxxxxxx768",
 "identitySpecific": false,
 "accountAttributes": [
 {
 "name": "defaultTablespaceQuotaInMB",
 "values": [
 "100"
 ],
 "children": [],
 "isQuestion": true
 }
 ]
 }
 ]
}

Example of the Response Code

You'll receive 200 OK response along with the following response body:

{
  "id": "0ff9207f-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "justification": "Sample justification",
  "requestStatus": "PENDING_APPROVALS",
  "timeCreated": "2025-04-11T08:10:51.357Z",
  "timeUpdated": "2025-04-11T08:10:51.357Z",
  "createdBy": "globalId.125123c3-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "permissionRoles": [],
  "accessBundles": [
    {
      "id": "6adcbc8d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Example payload",
      "displayName": "Example payload",
      "accountProfileId": "84321700-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ],
  "identities": [
    {
      "id": "globalId.OCI.bd49ff2a-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Bill.Clark@example.com",
      "displayName": "Bill Clark",
      "owners": null
    }
  ],
  "attributes": {
    "orchestratedSystemAttributes": null
  },
  "approvalRequests": null
}

Request Payload for Request Limited to Members of Organization

{
  "justification": "Database-Infra Access Request for Members Only",
  "createdBy": "globalId.1251xxc3-eexx-4d6a-b6d4-6c0fxx37bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
  "accessBundles": [
    "08f5xxbe-5261-4146-af78-8fb7xx8568bb8"
  ],
  "identities": [
    "globalId.ICF.4564xx83-1e06-417a-888a-864exxb1f4db.e12axx250df05186a3d0dff3bf7cf770",
    "globalId.ICF.4564xx83-1e06-417a-888a-864exxb1f4db.7467xx8f03826ddc8a670280e0e7d6e8"
  ],
  "accountProfileDetails": [
    {
      "accountProfileId": "8432xx00-1a93-4cf2-9226-3f4cxxfd9768",
      "identitySpecific": false,
      "accountAttributes": [
        {
          "name": "defaultTablespaceQuotaInMB",
          "values": [
            "100"
          ],
          "children": [],
          "isQuestion": true
        },
        {
          "name": "defaultTablespace",
          "values": [
            "DBINFRA_CATALOG_INDEX_TAB"
          ],
          "isQuestion": false
        }
      ]
    }
  ],
  "accessLimitDataDetails": [
    {
      "accessBundleId": "08f5xxbe-5261-4146-af78-8fb7xx8568bb8",
      "isIdentitySpecific": false,
      "accessLimitDataInfo": {
        "accessLimitType": "NUMBER_OF_HOURS",
        "accessLimitData": {
          "daysConfig": null,
          "hoursConfig": {
            "expirationInHours": 24,
            "notificationInHours": 24,
            "extensionInHours": 8,
            "extensionApprovalWorkflowId": {
              "id": "Guid_03f0xxcc-129a-43dc-a8e9-76c8xxd07804",
              "name": "Custom_WF_Amel Maclead",
              "displayName": "Custom_WF_Amel Maclead"
            }
          },
          "dateTimeConfig": null
        }
      }
    }
  ]
}
Back to Top