Updates the group information for a group
Updates the group name and modifies, or sets, the permission profile for the group.
Related topics
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Request Body
application/json
This object is used for both requests and responses. Some properties (such as endPosition) only apply to the response of Groups: list.
The last index position in the result set.
A collection group objects containing information about the groups.
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.
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.
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.
The starting index position of the current result set.
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/groups" \ -H "Content-Type: application/json" \ -d '{}'{ "endPosition": "string", "groups": [ { "accessType": "string", "dsGroupId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "groupId": "string", "groupName": "string", "groupType": "string", "isManagedByScim": true, "lastModifiedOn": "string", "permissionProfileId": "string", "userGroupType": "string", "users": [ { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } ], "usersCount": "string" } ], "nextUri": "string", "previousUri": "string", "resultSetSize": "string", "startPosition": "string", "totalSetSize": "string"}