GroupApi
getAllGroups
Get all user groups.
Endpoint | /app/rest/userGroups |
Produces |
|
Parameters |
|
Response |
addGroup
Add a new user group.
deleteGroup
Delete user group matching the locator.
Endpoint | /app/rest/userGroups/{groupLocator} |
Parameters |
|
getUserGroupOfGroup
Get user group matching the locator.
Endpoint | /app/rest/userGroups/{groupLocator} |
Produces |
|
Parameters |
|
Response |
getGroupParentGroups
Get parent groups of the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/parent-groups |
Produces |
|
Parameters |
|
Response |
setGroupParentGroups
Update parent groups of the matching user group.
getGroupProperties
Get properties of the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/properties |
Produces |
|
Parameters |
|
Response |
removeGroupProperty
Remove a property of the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/properties/{name} |
Parameters |
|
getGroupProperty
Get a property of the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/properties/{name} |
Produces |
|
Parameters |
|
Response |
|
setGroupProperty
Update a property of the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/properties/{name} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getGroupRoles
Get all roles of the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/roles |
Produces |
|
Parameters |
|
Response |
addRoleToGroup
Add a role to the matching user group.
setGroupRoles
Update roles of the matching user group.
removeRoleAtScopeFromGroup
Remove a role with the specific scope from the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope} |
Parameters |
|
getGroupRoleAtScope
Get a role with the specific scope of the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope} |
Produces |
|
Parameters |
|
Response |
addRoleAtScopeToGroup
Add a role with the specific scope to the matching user group.
Endpoint | /app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope} |
Produces |
|
Parameters |
|
Response |