Send Requests

Use the following guidelines when sending requests using the Oracle Identity Governance (OIG) Self Service REST API.

URL Structure

Access the OIG Self Service REST resources using the following URL structure:

https://<subdomain>.<domain>.com:<port>/<resource-path>
Where:
  • <subdomain.domain>.com:<port>: Host and port where OIG is running.

  • <resource-path>: Relative path that defines the resource.

Supported Methods

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

HTTP Method Description
GET

Retrieves one or more complete or partial resources.

HEAD

Default jersey support.

POST

Creates new resources or creates search requests, depending on the endpoint.

PUT

Modifies a resource by replacing existing attributes with a specified set of replacement attributes (replace). PUT must not be used to create new resources.

.
PATCH

Modifies a resource with a set of client-specified changes (partial updates).

OPTIONS

Default jersey support.

DELETE

Deletes a resource.

.

Media Types

The following media types are supported by the OIG Self Service REST API:

  • application/json

  • application/xml

Supported Headers

The OIG Self Service REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json
ResponseTime The time in milliseconds to process the request. ResponseTime: 1000
X-Requested-By All clients sending non-GET requests to include a custom HTTP header (X-Requested-By), as all requests without it will be ignored and will return a 400 error. CSRF-header