Manage User Groups
This article lists REST API requests concerning user groups.
Get User Groups
To get all user groups, use:
/app/rest/userGroups
The endpoint responds with a Groups entity which contains instances of a Group entities.
Get User Group Details
A specific user group can be retrieved via:
/app/rest/userGroups/<groupLocator>
groupLocator is typed as UserGroupLocator.
Create User Group
To create a new user group, POST a Group entity to:
/app/rest/userGroups
Example payload:
<group key="key" name="groupName" description="description">
<users>
<user username="username"/>
</users>
<roles>
<role roleId="roleId">
</roles>
</group>
{
"roles" : {
"role" : {
"roleId": "roleId"
}
},
"name" : "name",
"description" : "description",
"key" : "key",
"users" : {
"user" : [
{
"username" : "username"
}
]
}
}
Delete User Group
To delete a group, use the following request:
/app/rest/userGroups/<groupLocator>
Last modified: 22 May 2023