Getting StartedAPI ReferenceRecipesGitHub
API Reference
Start typing to search…

Update Group

put
https://cluster.ip.address/v2/groups/

Privileges: PRINCIPAL_MODIFY

Only group settings on the Cohesity Cluster are updated. No changes are made to the referenced group principal on the Active Directory/IdP.

Path Params
string
required

Specify the SID of the group.

Body Params

Specifies the group information.

string | null

Specifies the description of the group.

localGroupParams
object | null

Specifies properties for LOCAL Cohesity group.

boolean | null

Specifies whether the Group is restricted. A restricted group can only view & manage the objects it has permissions to.

roles
array of strings

Specifies the Cohesity roles to associate with the group. The Cohesity roles determine privileges on the Cohesity Cluster for this group.

roles
tenantIds
array of strings

Specifies a list of tenant ids who can access this group.

tenantIds
Responses

Updated 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago