Chat now with support
Chat with Support

Identity Manager 8.0 - REST API Reference Guide

Single Entities

The following APIs are used to handle entities of the 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

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 (mandatory)

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"

}

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 (mandatory)

path

string

uid

Guid of this entity (mandatory)

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)

}

Related Documents