Send Requests

Use these guidelines when sending requests using the Oracle Access Governance REST API.

Understanding URL Structure

Here's the URL structure for the requests:

https:<host>/path/resource-path
where,

Note:

Use the Latest API version ID to send your requests. For more information, see Latest API Version.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.

Note:

You can combine multiple operations into a single HTTP request to improve performance.
Resources GET POST PUT PATCH DELETE
AccessBundles Yes Yes Yes Yes Yes
Access Request Yes Yes No No No
AccountProfile Yes No No No No
ApprovalWorkflow Yes No No No No
Identities Yes No No No No
OrchestratedSystem Yes Yes No No No

Media Types

The following media types are supported by the Oracle Access Governance REST APIs.
  • For Authorization

    Content-Type: application/x-www-form-urlencoded

  • For Request Body ( for requests requiring content)

    Content-Type: application/json

  • For Response

    Content-Type: application/json

Supported Headers

The Oracle Access Governance REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Authorization OAuth Bearer token required before accessing a resource. Bearer <token value>
Content-Type Media type of the body of the request. Required for POST and PUT requests.
  • For Authorization

    Content-Type: application/x-www-form-urlencoded

  • For Request Body ( for requests requiring content)

    Content-Type: application/json

  • For Response

    Content-Type: application/json
opc-request-id Unique header identifier for each response. If you need to contact support about a particular request, provide the request ID. oci-12345678-2AAddffs
opc-next-page Unique pagination identifier when a list of items are returned. If partial list is returned, then include this token in the page parameter to retrieve the next batch. AAAAAWHT6XXXXMXXXXYQFES3XXX
Content-Encoding Response Header gzip

Standard Query Parameters for Oracle Access Governance REST APIs

You can use query parameters to control what data is returned in endpoint responses. Each endpoint may support different query parameters. Refer to specific endpoint reference to see the applicable parameters and their usage.

${host}/access-governance/access-controls/20250331/accessBundles?sortOrder=DESC&sortBy=name&keywordContains=oci

Here are a few standard query parameters:

Parameters Description Examples
limit To prevent the response from becoming too large, use this to restrict the response.
  • Minimum: 1
  • Maximum: 100
  • Default: 10
?limit=20
sortOrder Sort order to use while retrieving results.

Allowed Values: [ASC, DESC]

 ?orderBy=ASC
sortBy The attribute used in sorting. You can sort the results by timeCreated, name or displayName.

Note:

Refer to specific endpoint details to see the applicable allowed values.
By default,timeCreated is descending and displayName is displayed in ascending order. 		?sortBy=name
keywordContains Filters result based on the occurrence of the specified keyword in the name. Supports wildcard search implicitly based on name.

Note:

Refer to specific endpoint reference to see the applicable allowed values.

For example, for identities, it can search for last name, first name, user name, primary Email, manager display name, and the identity display name.

 ?keywordContains=oci
page Used for pagination. To retrieve response from subsequent pages, take the value from opc-next-page returned in the previous call and pass it to the page query parameter ?page=<opc-next-page token from previous response>