Create Groups

post

https://helios.cohesity.com/v2/groups

If an Active Directory/IdP domain is specified, a new group is added to the Cohesity Cluster for the specified Active Directory/IdP group principal. If the LOCAL domain is specified, a new group is created directly in the default LOCAL domain on the Cohesity Cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the new group parameters.

groups

array of objects

length ≥ 1

Specifies the list of groups to be created.

groups

name

string

required

Specifies the name of the group.

domain

string

required

Specifies the domain of the group. For active directories, this is the fully qualified domain name (FQDN). It is 'LOCAL' for local groups on the Cohesity Cluster. A group is uniquely identified by combination of the name and the domain.

groupType

string

enum

required

Specifies the type of group: local, ad, or idp.

Allowed:

description

string | null

Specifies the description of the group.

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

restricted

boolean | null

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

tenantIds

array of strings

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

tenantIds

localGroupParams

object | null

Specifies properties for LOCAL Cohesity group.

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201Success

defaultError