Group API can perform functions to interact or exchange data with Groups.
Add group
Add a new group.
Name
{ "id": "apiTestGroup", "name": "API Test Group", "description": "This is a group created by API." }
Assign user to group
Assign a Joget user to a group.
{ "username": "cat", "groups": [ { "id": "G-004", "name": "API Test Group", "description": "This is API generated group.", "organizationId": "" } ] }
Delete group
Delete a group via group ID.
{ "date": "Wed Aug 28 16:13:00 SGT 2019", "code": "200", "message": "Successful operation" }
Find group
Get all groups by default.
Able to filter or sort the returned results via parameters.
Group data column to sort.
Must be used in conjunction with "sortDescending" parameter.
Sort the specified "sort" parameter value in ascending or descending order.
Expects a boolean value.
Must be used in conjunction with "sort" parameter.
[ { "id": "G-001", "name": "Managers", "description": "" }, { "id": "G-002", "name": "CxO", "description": "" }, ..... ]
Find group by username
Find the group that belongs to the specified user via username.
Search for group(s) that the user belongs or does not belong to.
[ { "id": "G-001", "name": "Managers", "description": "" } ]
Get group by ID
Get details of a group via group ID.
{ "id": "G-002", "name": "CxO", "description": "" }
Unassign user from group
Unassign a Joget user from a group.
{ "date": "Thu Dec 05 03:29:56 SGT 2019", "code": "200", "message": "Successful operation" }
Update group
Update the details of a group.
{ "id": "apiTestGroup", "name": "API Test Group", "description": "This group is updated via API." }