Identity Manager 8.2 - REST API Reference Guide

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

Assignments

Get assignments for a specific entity Add assignments Remove assignments

Scripts

Run script request

Windows PowerShell sample

Single entities

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.

Detailed information about this topic

Create a single entity

Single entities > Create a single entity

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

Table 26: 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 27: 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:

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"

}

Create a batch of single entities

Single entities > Create a batch of single entities

To create a batch single entity, use the URL <baseURL>/api/entities

Table 28: Create a batch of single entities request
HTTP method	URI	Body
Post	<BaseURL>/api/entities	{ "entities": [ { "table": "string", "values": { "StringColumn": "string", "IntColumn": 0, "DateColumn": "2016-0519T11:21:33.579Z", "DoubleColumn": 3.14, "BoolColumn": true } } ] }

Table 29: Create a batch of single entities parameters
Parameter	Description	Parameter type	Data type
entities	List of entities to create (required)	Body	array[InsertEntity]

Body schema:

BulkChangeBodyInsert {

entities(array[InsertEntity])

}

InsertEntity {

table(string),

values(SampleValues, optional)

}

SampleValues {

StringColumn(string, optional),

IntColumn(integer, optional),

DateColumn(date - time, optional),

BoolColumn (boolean, optional)

}

Response schema:

CreateBulkResult {

entities(Array[UidAndUri])

UidAndUri {

uid (string, optional),

uri (string, optional)

}

Example:

https://<Hostname>/AppServer/api/entities

Body:

{

"entities": [

{

"table": "Person",

"values": {

"FirstName": "Jeremia",

"LastName": "Bodewell",

"IsExternal": True,

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

"Gender": 1

}

{

"table": "Person",

"values": {

"FirstName": "Rose",

"LastName": "Gladstone",

"IsExternal": False,

"BirthDate": "1991-03-21",

"Gender": 2

}

]

}

Response:

{

"entities": [

{

"uid": "8a2eee88-0615-4595-a903-8388ca74d877",

"uri": "/AppServer/api/entity/Person/8a2eee88-0615-4595-a903-8388ca74d877"

{

"uid": "df563a8c-203a-4132-8fcb-bc4adaee35b6",

"uri": "/AppServer/api/entity/Person/df563a8c-203a-4132-8fcb-bc4adaee35b6"

}

]

}

Get a single entity

Single entities > Get a single entity

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

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

Table 31: 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)

}

Example:

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

Response:

{

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

"display": "Bodewell, Jeremia (JEREMIAB)",

"values": {

"ApprovalState": 0,

"AuthentifierLogins": "",

"BirthDate": "1993-05-14T00:00:00.0000000Z",

"Building": "",

"CanonicalName": "",

"CentralAccount": "JEREMIAB",

"CentralPassword": "",

"CentralSAPAccount": "BODEWELJ",

...

"XObjectKey": "<Key><T>Person</T><P>83b10e84-c64e-4f9f-9ecb-2d0d7c94e8ec</P></Key>",

"XTouched": "",

"XUserInserted": "<user name>",

"XUserUpdated": "<user name>",

"ZIPCode": ""

}

Please select your product:

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

Recommended Solutions for Your Problem

Identity Manager 8.2 - REST API Reference Guide

Single entities

Detailed information about this topic

Create a single entity

Body schema:

Response schema:

Example:

Body:

Response:

Create a batch of single entities

Body schema:

Response schema:

Example:

Body:

Response:

Get a single entity

Response schema:

Example:

Response: