To get a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}.
Query parameters to be used in WHERE clauses and predefined WHERE clauses can be provided in the form @paramname=value. Per default they have the type string. Additionally, it is possible to pass the type with the name: @otherParam[int]=3. Types originate from DbVal class.
Table 42: Get assignments request
|
Get |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
None |
Table 43: Get 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 |
|
where |
WHERE clause. |
query |
string |
| whereKey |
Predefined WHERE clause from QBMLimitedSQL (Key [UID] or ID [Ident_QBMLimitedSQL]). |
query |
string |
|
orderBy |
ORDER BY clause. |
query |
string |
|
offset |
Offset of first item. |
query |
integer |
|
limit |
Maximum number of results. |
query |
integer |
|
displayColumns |
Additional display columns, semicolon separated. |
query |
string |
|
loadType |
Collection load type. Specify one of the values:
-
Default: Loads read-only entities according to the supplied query. Loaded columns include the primary key, display columns according to the display pattern, some special columns, and the columns defined in the select clause of the query. The entries are sorted by the defined display or the optional orderBy clause of the query. This load type is the default and be omitted.
-
Slim: Works mostly like Default but does not load display columns and does not build an orderBy clause per default. This type is useful when loading data not intended for display and can save much time by using database indexes.
-
BulkReadOnly: Loads read-only entities with all columns filled. The columns defined in the query are overridden.
-
ForeignDisplays: Loads display values for foreign keys contained in the display pattern. This allows showing displays instead of UIDs for foreign keys.
-
ForeignDisplaysForAllColumns: Like ForeignDisplays, but loads displays for all foreign keys contained in the select clauses of the query, not only columns referenced in the display pattern. |
query |
string |
|
noUrls |
Allow to omit the URI property from the response to reduce the response size especially if used while retrieving large M:N tables like PersonHasObject. |
query |
boolean |
Response schema:
array {
href(string),
title(string),
uid(string)
}
Example:
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f?limit=2
Response:
[
{
"href": "https://<Hostname>/AppServer/api/entity/Person/a9c6bc62-3f77-453f-b774-3afd9d4d19e0",
"title": "Abbey, Jenna (JENNAA) - KAGU Org",
"uid": "a9c6bc62-3f77-453f-b774-3afd9d4d19e0"
},
{
"href": "https://<Hostname>/AppServer/api/entity/Person/be514f69-fc8f-49c0-a791-2b79b8f5cbdf",
"title": "Abbott, James (JAMESA) - KAGU Org",
"uid": "be514f69-fc8f-49c0-a791-2b79b8f5cbdf"
}
]
To add a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}.
Table 44: Add assignments request
|
Post |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
{"members": ["string"]} |
Table 45: 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[] |
| ignoreExisting |
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 46: Remove assignments request
|
Delete |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
{"members": ["string"]} |
Table 47: 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
