Identity Manager 8.0.5 - REST API Reference Guide

Guidelines and Conventions

This document provides development information for customers and partners intending to use One Identity Manager REST APIs.

The initial sections provide general guidelines and conventions for reference.

BaseURL

The One Identity Manager REST API is an integral part of the One Identity Manager Application Server. The BaseURL specifies the path to an Application Server installation. By default, the Application Server will be installed with the following path.

https://<Hostname>/AppServer

Parameter Formats

The HTTP requests use two types of parameters:

• Path parameters
• Query parameters

Path Parameters

Path parameters continue the URI path using a slash for a separator. For example, to get details for a person, you specify its primary key (GUID) with a path parameter. The following shows the URI format for this request, and an example:

<BaseURL>/api/entity/{table}/{uid}

https://<Hostname>/AppServer/api/entity/Person/25d87790-105d-4afb-bd04-cfddc7cc9fb5

If a request uses path parameters, they are specified in the URI format for the request.