Update an existing group on the Cohesity Cluster. Only group settings on the Cohesity Cluster are updated. No changes are made to the referenced group principal on the Active Directory.

put

https://cluster.ip.address/irisservices/api/v1/public/groups

Privileges: PRINCIPAL_MODIFY

Returns the group that was updated on the Cohesity Cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to update a group.

Specifies the settings used to add/create a new group or modify an existing
group.

description

string | null

Specifies a description of the group.

domain

string | null

Specifies the domain of the group.

name

string | null

Specifies the name of the group.

restricted

boolean | null

Whether the group is a restricted group. Users belonging to a restricted
group can only view objects they have permissions to.

roles

array of strings | null

Array of Roles.

Specifies the Cohesity role names to associate with the group.
role names can be viewed by GET /irisservices/api/v1/public/roles,
example: COHESITY_VIEWER
The Cohesity roles determine privileges on the Cohesity Cluster
for all the users in this group.

roles

smbPrincipals

array of objects | null

Specifies the SMB principals. Principals will be added to this group only
if IsSmbPrincipalOnly set to true.

smbPrincipals

tenantIds

array of strings | null

Specifies the tenants to which the group belongs to. If not specified,
session user's tenant id is assumed.

tenantIds

users

array of strings | null

Specifies the SID of users who are members of the group.
This field is used only for local groups.

users

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError