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

Set global variables

Guidelines and conventions > Session object global variables > Set global variables

To set a set of global variables, use the URL <baseURL>/api/variables

Table 12: Set a set of global variable request
HTTP method	URI	Body
Put	<baseURL>/api/variables	{"variables": { "variablename": <value> }}

Table 13: Set global variable parameters
Parameter	Description	Parameter type	Data type
variables	Variable names (required)	body	string

Body schema:

{"variables": {

"variablename": <value>

}}

Example:

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

Body:

{"variables": {"FullSync": True, "MyVariable": 42}}

Clear global variables

Guidelines and conventions > Session object global variables > Clear global variables

To clear a set of global variables, use the URL <baseURL>/api/variables/clear

Table 14: Clear a set of global variable request
HTTP method	URI	Body
Put	<baseURL>/api/variables/clear	{"variables": [ "string" ]}

Table 15: Clear global variable parameters
Parameter	Description	Parameter type	Data type
variables	Variable names (required)	body	string

Body schema:

{

"variables": [

"string"

]

}

Example:

https://<Hostname>/AppServer/api/variables/clear

Body:

{"variables": ["FullSync", "MyVariable"]}

Running the Application Server in REST API only mode

Guidelines and conventions > Running the Application Server in REST API only mode

The Application Server can be restricted to the pure REST API only. To do this, modify the Web.config file. All services necessary for login and status page are not affected by the switch-off.

Settings for the Application Server plugins in the Web.config file

</restapi>

</appserverapi>

Collections

To get a list of entities, you have the option to use a GET or POST request against the REST API. Both methods support to query by example. Simply provide the columns to query in the form Name=Value in the URL.

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

Set global variables

Body schema:

Example:

Body:

Clear global variables

Body schema:

Example:

Body:

Running the Application Server in REST API only mode

Settings for the Application Server plugins in the Web.config file

Collections

Detailed information about this topic