Quick Start

Use the information in this topic to help you get started with Oracle Unified Directory (OUD) REST APIs.

Prerequisites

Prerequisite More Information
The installation of OUD See Oracle Fusion Middleware Installing Oracle Unified Directory.
An OUD account An OUD Admin User account is required to use the Admin REST APIs. See Configuring Root Users.
HTTP Administration Connector Configuration of an Administration Connector on OUD for supporting HTTP based communication. Use dsconfig to enable or manage this connector.

Step 1: Obtain Account Information

From your account administrator, obtain the appropriate account credentials to enable you to perform tasks. Specifically, you will need:
  • User name and password

Step 2: Install cURL

The examples within this document use the cURL command-line tool to demonstrate how to access the Oracle Unified Directory REST API.

To connect securely to the server, you must install a version of cURL that supports SSL and provide an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate. For more information about:

The following procedure demonstrates how to install cURL on a Windows 64 bit system.
  1. In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.

  2. On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.

  3. Navigate to the cURL CA Certs page at http://curl.haxx.se/docs/caextract.html and download the ca-bundle.crt SSL CA certificate bundle in the folder where you installed cURL.

  4. Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable, CURL_CA_BUNDLE, to the location of an SSL certificate authority (CA) certificate bundle. For example:

    C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt

You are now ready to send requests to Oracle Unified Directory using cURL.