List the users on the Cohesity Cluster that match the filter criteria specified using parameters.

get

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

No Privileges Required

If no parameters are specified, all users 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

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.

usernames

array of strings

Optionally specify a list of usernames to filter by. All users containing
username will be returned.

usernames

emailAddresses

array of strings

Optionally specify a list of email addresses to filter by.

emailAddresses

domain

string

Optionally specify a domain to filter by.
If no domain is specified, all users on the Cohesity Cluster are searched.
If a domain is specified, only users on the Cohesity Cluster
associated with that domain are searched.

partialMatch

boolean

Optionally specify whether to enable partial match. If set, all users
with name containing Usernames will be returned. If set to false, only
users with exact the same name as Usernames will be returned. By default
this parameter is set to true.

includeOnlyTenantsUsers

boolean

Providing this option will only return tenant users and
will not include out any local 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