Use these guidelines when sending requests using the Oracle Advanced Authentication REST API.

URL Structure

Here's the URL structure for the requests:

https://<subdomain>.<domain>.com:<port>/<resource-path>
Where:

  • <subdomain.domain>.com:<port>: Host and port where Oracle Advanced Authentication is running.

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

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.

HTTP Method Description
GET Retrieve information about the resource
HEAD Retrieve header information.
POST Create resources.
PUT Update the resource.
DELETE Delete the Resource.

Media Types

The following media types are supported by the Oracle Advanced Authentication REST API:

  • application/json

  • application/xml

Supported Headers

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

Header Description Example
Accept-Encoding List of acceptable encodings to support compression. Accept-Encoding: gzip
Content-Encoding List of acceptable encodings to support compression. Content-Encoding: deflate
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json