The following APIs are used to handle assignments in member tables for the entities of One Identity Manager.
The following APIs are used to handle assignments in member tables for the entities of One Identity Manager.
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.
HTTP method |
URI |
Body |
---|---|---|
Get |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
None |
Parameter |
Description |
Parameter type |
Data type |
---|---|---|---|
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:
|
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 |
array {
href(string),
title(string),
uid(string)
}
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f?limit=2
[
{
"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}.
HTTP method |
URI |
Body |
---|---|---|
Post |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
{"members": ["string"]} |
Parameter |
Description |
Parameter type |
Data type |
---|---|---|---|
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 |
AssignmentResult {
assigned (int, optional),
removed (int, optional),
alreadyAssigned (Array[string], optional)
}
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f
{"members": [
"31d99791-d658-40d7-b5e5-58eecf998797",
"40e43904-4958-4bce-915b-f77bab675f06",
"7c21b251-d774-4616-bc3a-b91506ddb23b"]
}
{
"assigned": 3,
"removed": 0
}
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e78954-82374340718f?ignoreExisting=true
{"members": [
"31d99791-d658-40d7-b5e5-58eecf998797",
"40e43904-4958-4bce-915b-f77bab675f06",
"7c21b251-d774-4616-bc3a-b91506ddb23b"]
}
{
"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}.
HTTP method |
URI |
Body |
---|---|---|
Delete |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
{"members": ["string"]} |
Parameter |
Description |
Parameter type |
Data type |
---|---|---|---|
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[] |
AssignmentResult {
assigned (int, optional),
removed (int, optional)
}
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f
{"members": ["31d99791-d658-40d7-b5e5-58eecf998797"]}
{
"assigned": 0,
"removed": 1
}
© ALL RIGHTS RESERVED. Feedback 이용 약관 개인정보 보호정책 Cookie Preference Center