models.group_parameters module

class models.group_parameters.GroupParameters(description=None, domain=None, name=None, restricted=None, roles=None, smb_principals=None, tenant_ids=None, users=None)

Bases: object

Implementation of the ‘GroupParameters’ model.

Specifies the settings used to add/create a new group or modify an existing group.

Attributes:

description (string): Specifies a description of the group. domain (string): Specifies the domain of the group. name (string): Specifies the name of the group. restricted (bool): Whether the group is a restricted group. Users

belonging to a restricted group can only view objects they have permissions to.

roles (list of string): Array of Roles. Specifies the Cohesity roles

to associate with the group such as ‘Admin’, ‘Ops’ or ‘View’. The Cohesity roles determine privileges on the Cohesity Cluster for all the users in this group.

smb_principals (list of SmbPrincipal): Specifies the SMB principals.

Principals will be added to this group only if IsSmbPrincipalOnly set to true.

tenant_ids (list of string): Specifies the tenants to which the group

belongs to. If not specified, session user’s tenant id is assumed.

users (list of string): Specifies the SID of users who are members of

the group. This field is used only for local groups.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

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.

Returns:

object: An instance of this structure class.