Groups Resource

The Groups resource provides methods that allow you to manage groups for the account.

Groups can be used to help manage users by associating users with a group. A group can be associated with a Permission Profile, which sets the user permissions for users in that group without having to set the userSettings property for each user. You are not required to set Permission Profiles for a group, but this makes it easier to manage user permissions for a large number of users. Groups can also be used with template sharing to limit user access to templates.

Methods supported

Method	Description
create	POST `/restapi/v2.1/accounts/{accountId}/groups` Creates one or more groups for the account.
delete	DEL `/restapi/v2.1/accounts/{accountId}/groups` Deletes an existing user group.
list	GET `/restapi/v2.1/accounts/{accountId}/groups` Gets information about groups associated with the account.
update	PUT `/restapi/v2.1/accounts/{accountId}/groups` Updates the group information for a group.

Groups properties

Property	Type	Description
`endPosition`	string	The last index position in the result set.
`groups`	array	A collection group objects containing information about the groups.
`nextUri`	string	The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
`previousUri`	string	The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
`resultSetSize`	string	The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
`startPosition`	string	The starting index position of the current result set.
`totalSetSize`	string	The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.