Identity Manager 8.1.4 - REST API Reference Guide

The following APIs are used to handle entities of One Identity Manager. You can create, read, update, and delete single entities as well as call methods of an entity and generate events.

Create a single entity

Single entities > Create a single entity

To create a single entity, use the URL <baseURL>/api/entity/{table}

Table 18: Create single entity request
HTTP method	URI	Body
Post	<BaseURL>/api/entity/{table}	{"values": { "StringColumn": "string", "IntColumn": 0, "DateColumn": "2016-05-19T11:21:33.579Z", "BoolColumn": True }

Table 19: Create single entity parameters
Parameter	Description	Parameter type	Data type
table	Table name (required)	path	string
values	Values to set	body	SampleValues

Body schema:

SingleChangeBody {

values(SampleValues, optional)

}

SampleValues {

StringColumn(string, optional),

IntColumn(integer, optional),

DateColumn(date - time, optional),

BoolColumn (boolean, optional)

}

Response schema:

CreateSingleResult {

uid (string, optional),

uri (string, optional)

}

Example

Single entities > Create a single entity > Example

https://<Hostname>/AppServer/api/entity/Person

Body:

{

"values": {

"FirstName": "Jeremia",

"LastName": "Bodewell",

"IsExternal": True,

"BirthDate": "1993-05-14",

"Gender": 1

}

Response:

{

"uid": "83b10e84-c64e-4f9f-9ecb-2d0d7c94e8ec",

"uri": "https://<Hostname>/AppServer/api/entity/Person/83b10e84-c64e-4f9f-9ecb-2d0d7c94e8ec"

}

Get a single entity

Single entities > Get a single entity

To get a single entity, use the URL <baseURL>/api/entity/{table}/{uid}

Table 20: Get single entity request
HTTP method	URI	Body
Get	<BaseURL>/api/entity/{table}/{uid}	None

Table 21: Get single entity parameters
Parameter	Description	Parameter type	Data type
table	Table name (required)	path	string
uid	Guid of this entity (required)	path	string

Response schema:

SingleEntry {

uri (string),

uid (string, optional),

display (string, optional),

values (SampleValues, optional),

links (Array[Link], optional)

}

SampleValues {

StringColumn (string, optional),

IntColumn (integer, optional),

DateColumn (date-time, optional),

BoolColumn (boolean, optional)

}

Link {

name (string, optional)

}

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Identity Manager 8.1.4 - REST API Reference Guide

Single entities

Create a single entity

Body schema:

Response schema:

Example

Body:

Response:

Get a single entity

Response schema: