Send Requests

There are certain guidelines that you should follow when you build send requests using the Oracle Identity Cloud Service REST API.

URL Structure

Access the Identity Cloud Service REST API through a URL, which includes the REST endpoint, the resource that you want to access, and any query parameters that you want to include in your request. Get the complete URL structure for the Identity Cloud Service REST API from your Oracle Cloud Administrator or Identity Domain Administrator.

Basic Endpoint

The basic endpoint for the Identity Cloud Service REST API is:

https://tenant-base-url/admin/v1

Where: tenant-base-url represents the tenant-specific host name and the port that this server uses to communicate with the REST API (typically port 8943). Get this URL from your Oracle Cloud Administrator or Identity Domain Administrator.

Resource Endpoints

When you create a new resource or perform a search for members of a resource type, you append the name of the resource. For example, when you send a POST request to create a new user, you use the endpoint:

https://tenant-base-url/admin/v1/Users

Specific Resources Within an Endpoint

If you want to access a specific resource, you append the value of the id attribute for that resource to the resource endpoint. For example, if you created a User, and the response to your POST request included the id value F838F4BECDE4EBAEE040F00AADC011E9 in the response body, you would use the following endpoint to access that specific User resource in subsequent GET, PATCH, or PUT requests:

https://tenant-base-url/admin/v1/Users/F838F4BECDE4EBAEE040F00AADC011E9

Supported Methods

The Identity Cloud Service REST API supports the following five request methods.

Note:

The methods supported depend on the endpoint.

HTTP Method	Description
GET	Search for resources or search for a specific resource by ID.
POST	Create, change, reset, import, authenticate, schedule, or create a search request to Oracle Identity Cloud Service resources.
PUT	Replace (fully update) an existing Oracle Identity Cloud Service resource, activate or deactivate an Oracle Identity Cloud Service resource, and so on.
PATCH	Modify (partially update) Oracle Identity Cloud Service resources.
DELETE	Delete or cancel Oracle Identity Cloud Service resources.

Supported Headers

The Identity Cloud 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/scim+jsonContent-Type: application/json
Authorization	The OAuth access token used to access protected resources	Access token are very long strings. This example has been truncated: Bearer eyJ4NXQjUzI1Ni......VkdVAZrb_fw