Identity Manager 8.1.5 - REST API Reference Guide

Getting details of an authentication module

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

Set global variable

Example

Clear global variable

Example

Collections

Get collection using GET method

Example 1 Example 2

Get collection using POST method

Example

Single entities

Create a single entity

Example

Get a single entity

Example

Change a single entity

Example

Delete a single entity

Example

Call a method on an entity

Example 1 Example 2

Generate an event for an entity

Example

Assignments

Get assignments for a specific entity

Example

Add assignments

Example

Remove assignments

Example

Scripts

Run script request

Example 1 Example 2

Windows PowerShell sample About us

Example

Single entities > Get a single entity > 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",

"City": "",

"CompanyMember": "",

"CustomProperty01": "",

"CustomProperty02": "",

"CustomProperty03": "",

"CustomProperty04": "",

"CustomProperty05": "",

"CustomProperty06": "",

"CustomProperty07": "",

"CustomProperty08": "",

"CustomProperty09": "",

"CustomProperty10": "",

"DateLastWorked": "1899-12-30T00:00:00.0000000Z",

"DeactivationEnd": "1899-12-30T00:00:00.0000000Z",

"DeactivationStart": "1899-12-30T00:00:00.0000000Z",

"DefaultEmailAddress": "",

"Description": "",

"DialogUserPassword": "",

"DialogUserSalt": "",

"DisplayTelephoneBook": false,

"DistinguishedName": "",

"EntryDate": "2016-05-20T00:00:00.0000000Z",

"ExitDate": "1899-12-30T00:00:00.0000000Z",

"Fax": "",

"FaxExtension": "",

"FirstName": "Jeremia",

"Floor": "",

"FormerName": "",

"Gender": 1,

"GenerationalQualifier": "",

"ImportSource": "",

"Initials": "JB",

"InternalName": "Bodewell, Jeremia",

"IsCar": false,

"IsDummyPerson": false,

"IsDuplicateName": false,

"IsExternal": true,

"IsInActive": false,

"IsNoInherite": false,

"IsNoteBookUser": false,

"IsRemoteAccessAllowed": false,

"IsSecurityIncident": false,

"IsSupporter": false,

"IsTemporaryDeactivated": false,

"IsTerminalServerAllowed": false,

"IsVIP": false,

"IsX500Dummy": false,

"JPegPhoto": "",

"LastName": "Bodewell",

"MiddleName": "",

"NameAddOn": "",

"PasswordAnswer": "",

"PasswordQuery": "",

"PersonalTitle": "",

"PersonnelNumber": "",

"Phone": "",

"PhoneExtension": "",

"PhoneMobile": "",

"PostalOfficeBox": "",

"PreferredName": "",

"Remarks": "",

"RiskIndexCalculated": 0,

"Room": "",

"Salutation": "Mr",

"SecurityIdent": "",

"Sponsor": "",

"Street": "",

"SubCompany": "",

"TechnicalEntryDate": "1899-12-30T00:00:00.0000000Z",

"Title": "",

"UID_Department": "",

"UID_DialogCountry": "",

"UID_DialogCulture": "",

"UID_DialogState": "",

"UID_DialogUser": "",

"UID_FirmPartner": "",

"UID_Locality": "",

"UID_Org": "",

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

"UID_PersonHead": "",

"UID_PersonMasterIdentity": "",

"UID_ProfitCenter": "",

"UID_RealPerson": "",

"UID_WorkDesk": "",

"UID_X500Person": "",

"UserIDTSO": "",

"XDateInserted": "2016-05-20T09:12:25.7300000Z",

"XDateUpdated": "2016-05-20T09:12:25.7300000Z",

"XMarkedForDeletion": 0,

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

"XTouched": "",

"XUserInserted": "<user name>",

"XUserUpdated": "<user name>",

"ZIPCode": ""

}

Change a single entity

Single entities > Change a single entity

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

Table 22: Change single entity request
HTTP method	URI	Body
Put	<BaseURL>/api/entity/{table}/{uid}	{"values": { "StringColumn": "string", "IntColumn": 0, "DateColumn": "2016-05-19T11:21:33.579Z", "BoolColumn": true }

Table 23: Change single entity parameters
Parameter	Description	Parameter type	Data type
table	Table name (required)	path	string
uid	GUID of the entity (required)	path	string
values	Values to change	body	SampleValues

Body schema:

SingleChangeBody {

values(SampleValues, optional)

}

SampleValues {

StringColumn(string, optional),

IntColumn(integer, optional),

DateColumn(date - time, optional),

BoolColumn (boolean, optional)

}

Response schema:

{}

Example

Single entities > Change a single entity > Example

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

Body:

{

"values": {

"LastName": "Garibaldi",

"IsExternal": false,

"UID_Locality": "83615878-7205-408d-a5fa-f260840c867c"

}

Response Code:

200

Response:

{}

Delete a single entity

Single entities > Delete a single entity

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

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

Table 25: Delete single entity parameters
Parameter	Description	Parameter type	Data type
table	Table name (required)	path	string
uid	Guid of the entity (required)	path	string

Response schema:

{}

Please select your product:

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

Recommended Solutions for Your Problem

Identity Manager 8.1.5 - REST API Reference Guide

Example

Response:

Change a single entity

Body schema:

Response schema:

Example

Body:

Response Code:

Response:

Delete a single entity

Response schema: