/public/mcm/roles

post

https://helios.cohesity.com/irisservices/api/v1/public/mcm/roles

Creates the new role on Helios and returns the newly created role
object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a role in mcm.

Specifies information about role such as the category, privileges,
description, etc. A role can be a default system role
or a custom role. Custom roles are user-defined roles that are created
using the Cohesity Dashboard, the REST API or the CLI.
System roles are provided by default on the Cohesity Cluster.

createdTimeMsecs

int64 | null

Specifies the epoch time in milliseconds when the role was created.

description

string | null

Specifies a description about the role.

isCustomRole

boolean | null

Specifies if the role is a user-defined custom role.
If true, the role is a user-defined custom role that was created using
the REST API, the Cohesity Dashboard or the CLI.
If false, the role is a default system role that was created
during Cluster creation.

label

string | null

Specifies the label for the role as displayed on the Cohesity
Dashboard such as 'Viewer'.

lastUpdatedTimeMsecs

int64 | null

Specifies the epoch time in milliseconds when the role was last modified.

name

string | null

Specifies the internal Cluster name for the role such as COHESITY_VIEWER.
For custom roles, the name and the label are the same.
For default system roles, the name and label are different.

platformType

string | null

Specifies the platform type of the role.
For Helios roles this would be "Helios".
For NetBackup roles this would be "NetBackup".

privileges

array of strings | null

Array of Privileges.

Specifies the privileges assigned to the role. When a user or
group is assigned this role, these privileges
define the operations the user or group can perform on the
Cohesity Cluster.

privileges

scopeId

string | null

Specifies scope id. Empty for seeded roles.

scopeType

string | null

Specifies scope type. All for seeded roles.

tenantId

string | null

Specifies unique id of the tenant owning the role.

tenantIds

array of strings | null

Specifies id of tenants using this role.

tenantIds

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