Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Identity Manager 9.2 - REST API Reference Guide

Table of Contents

Guidelines and conventions

BaseURL Parameter formats

Path parameters Query parameters

HTTP request methods Request formats Response formats HTTP response codes Authentication

Initial data for authentication modules Identifying activated authentication modules Getting details of an authentication module Login Logout

Date formats Object identifiers Using offset and limit parameters to cycle through records Session object global variables

Set global variable Clear global variable Set global variables Clear global variables

Running the Application Server in REST API only mode Disabling WHERE clauses for the REST API of the Application Server

Get collection using GET method Get collection using POST method Get count of collection using GET method Get count of collection using POST method

Single entities

Create a single entity Create a batch of single entities Get a single entity Change a single entity Change a batch of single entities Delete a single entity Delete a batch of single entities Call a method on an entity Generate an event for an entity

Get assignments for a specific entity Add assignments Remove assignments

Run script request

Windows PowerShell sample

Guidelines and conventions

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

Guidelines and conventions > 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 is installed with the following path.

https://<Hostname>/AppServer

Parameter formats

Guidelines and conventions > Parameter formats

HTTP requests use two types of parameters:

Path parameters

Guidelines and conventions > Parameter formats > Path parameters

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

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

Example:

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.

Self Service Tools: Knowledge Base; Notifications & Alerts; Product Support; Software Downloads; Technical Documentation; User Forums; Video Tutorials; RSS Feed

Contact Us: Licensing Assistance; Technical Support; View All

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center