Getting StartedAPI ReferenceRecipesGitHub
API Reference

List the roles defined on the Cohesity Cluster.

get
https://cluster.ip.address/irisservices/api/v1/public/roles

Privileges: PRINCIPAL_VIEW

If the 'name' parameter is not specified, all roles defined on the
Cohesity Cluster are returned. In addition, information about each role
is returned such as the name, description, assigned privileges, etc.
If an exact role name (such as COHESITY_VIEWER) is specified in the
'name' parameter, only information about that single role is returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Specifies the name of the role.

tenantIds
array of strings

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

tenantIds
boolean

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

Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?