To add a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}
Table 47: Add assignments request
|
Post |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
{"members": ["string"]} |
Table 48: Add assignments parameters
|
table |
Member table name (required) |
path |
string |
|
column |
Column pointing to the base entity (required) |
path |
string |
|
uid |
GUID of the base entity (required) |
path |
string |
|
members |
GUIDs of the members to add (required) |
body |
string[] |
| ignore |
Ignore existing entries, do not try to add them again. |
query |
boolean |
Response schema:
AssignmentResult {
assigned (int, optional),
removed (int, optional),
alreadyAssigned (Array[string], optional)
}
Example 1:
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f
Body:
{"members": [
"31d99791-d658-40d7-b5e5-58eecf998797",
"40e43904-4958-4bce-915b-f77bab675f06",
"7c21b251-d774-4616-bc3a-b91506ddb23b"]
}
Response:
{
"assigned": 3,
"removed": 0
}
Example 2:
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e78954-82374340718f?ignoreExisting=true
Body:
{"members": [
"31d99791-d658-40d7-b5e5-58eecf998797",
"40e43904-4958-4bce-915b-f77bab675f06",
"7c21b251-d774-4616-bc3a-b91506ddb23b"]
}
Response:
{
"assigned": 0,
"removed": 0,
"alreadyAssigned": [
"31d99791-d658-40d7-b5e5-58eecf998797",
"40e43904-4958-4bce-915b-f77bab675f06",
"7c21b251-d774-4616-bc3a-b91506ddb23b"]
}
To remove a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}
Table 49: Remove assignments request
|
Delete |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
{"members": ["string"]} |
Table 50: Remove assignments parameters
|
table |
Member table name (required) |
path |
string |
|
column |
Column pointing to the base entity (required) |
path |
string |
|
uid |
GUID of the base entity (required) |
path |
string |
|
members |
GUIDs of the members to remove (required) |
body |
string[] |
Response schema:
AssignmentResult {
assigned (int, optional),
removed (int, optional)
}
Example:
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f
Body:
{"members": ["31d99791-d658-40d7-b5e5-58eecf998797"]}
Response:
{
"assigned": 0,
"removed": 1
}
The One Identity ManagerREST API allows you to run any script that is stored inside of the One Identity Manager database.
NOTE: The authenticated user must be entitled to use the Allow the starting of arbitrary scripts from the frontend (Common_StartScripts) program function in order to run a script.
Detailed information about this topic
To run a script, use the URL <baseURL>/api/script/{name}
Table 51: Run script request
|
Put |
<BaseURL>/api/script/{name} |
{
"parameters": [
"Parameter value"],
"base": "XObjectKey",
"value": "Sample value"",
"returnRawResult": true
} |
Table 52: Run script parameters
|
name |
Script name (required) |
path |
string |
|
parameters |
|
body |
object[] |
|
base |
Object key of base object |
body |
string |
|
value |
Content of the value variable in the script |
body |
object |
|
returnRawResult |
Allow to return the raw object or string as result. |
body |
boolean |
Body schema:
ScriptParameters {
parameters (object, optional),
base (string, optional): Object key of base object,
value (object, optional): Content of the Value variable in the script
}
Response schema:
ScriptResult {
result (object, optional): Return value of the script,
value (object, optional): Content of the Value variable in the script
}
Example 1:
https://<Hostname>/AppServer/api/script/QER_GetWebBaseURL
Body:
{}
Response:
{
"result": "https://<Hostname>/IdentityManager/"
}
Example 2:
https://<Hostname>/AppServer/api/script/VI_AE_BuildCentralAccount
Body:
{
"parameters": [
"f79c30fd-87bb-4958-a812-0683ddcac7c9",
"Adams",
"David"
]
}
Response:
{
}
Example 3:
https://<Hostname>/AppServer/api/script/VI_AE_BuildCentralAccount
Body:
{
"parameters": [
"f79c30fd-87bb-4958-a812-0683ddcac7c9",
"Adams",
"David"
],
"returnRawResult": true
}
Response:
{
}
