OVERVIEW

Below is a quick overview of the User Group APIs, more details can be found in the child pages.

API Functionality	HTTP Request Type	HTTP Request URL	URL Parameters	HTTP Request content	HTTP Response
Get User Group	GET	/api/2/groups/:group	:group = Group ID		Group Object of requested group
Get User Group list	GET	/api/2/groups?{params}	{params} = filters, sort, search, fields to return		List of Group summary Objects
Add User Group	POST	/api/2/groups		Group object for new group	Group summary Object
Update User Group	PUT	/api/2/groups/:group	:group = Group ID	Group object	Group summary Object
Delete User Group	DELETE	/api/2/groups/:group/delete	:group = Group ID
Add Users to User Group	PUT	/api/2/groups/:group/users	:group = Group ID	List of user emails or IDs	Group summary object

Comments

Last Updated: Nov 08,2024