List the groups that match the filter criteria specified using parameters.

get

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

No Privileges Required

If no parameters are specified, all groups currently on the Cohesity Cluster
are returned. Specifying parameters filters the results that are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Optionally specify a group name to filter by. All groups containing name
will be returned.

domain

string

If no domain is specified, all groups on the Cohesity Cluster are searched.
If a domain is specified, only groups on the Cohesity Cluster
associated with that domain are searched.

filterByOwnedDomains

boolean

If FilterByOwnedDomains is set to true, then the groups are filtered
to show only the ones that are in the domains owned by the current tenant
or user.

includeOnlyTenantsGroups

boolean

Providing this option will only return tenant groups
and will not include out any local groups

tenantIds

array of strings

TenantIds contains ids of the tenants for which objects are to be
returned.

tenantIds

allUnderHierarchy

boolean

AllUnderHierarchy specifies if objects of all the tenants under the
hierarchy of the logged in user's organization should be returned.

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