models.role module

class models.role.Role(created_time_msecs=None, description=None, is_custom_role=None, label=None, last_updated_time_msecs=None, name=None, privileges=None, tenant_id=None, tenant_ids=None)[source]

Bases: object

Implementation of the ‘Role’ model.

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.

created_time_msecs (long|int): Specifies the epoch time in

milliseconds when the role was created.

description (string): Specifies a description about the role. is_custom_role (bool): 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): Specifies the label for the role as displayed on the

Cohesity Dashboard such as ‘Viewer’.

last_updated_time_msecs (long|int): Specifies the epoch time in

milliseconds when the role was last modified.

name (string): 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.

privileges (list of string): 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.

tenant_id (string): Specifies unique id of the tenant owning the


tenant_ids (list of string): Specifies id of tenants using this role.

classmethod from_dictionary(dictionary)[source]

Creates an instance of this model from a dictionary


dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.


object: An instance of this structure class.