Skip to navigation

GroupUsers Resource

View as Markdown

The GroupUsers resource provides methods that allow you to manage the users in a group.

Methods supported

MethodDescription
deleteDEL /restapi/v2.1/accounts/{accountId}/groups/{groupId}/users
Deletes one or more users from a group
listGET /restapi/v2.1/accounts/{accountId}/groups/{groupId}/users
Gets a list of users in a group.
updatePUT /restapi/v2.1/accounts/{accountId}/groups/{groupId}/users
Adds one or more users to an existing group.

GroupUsers properties

PropertyTypeDescription
endPositionstringThe last index position in the result set.
nextUristringThe 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.
previousUristringThe 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.
resultSetSizestringThe 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.
startPositionstringThe starting index position of the current result set.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
usersarrayAn array of userInfo objects containing information about the users in the group.