models.user_parameters module

class models.user_parameters.UserParameters(additional_group_names=None, cluster_identifiers=None, description=None, domain=None, effective_time_msecs=None, email_address=None, expired_time_msecs=None, password=None, primary_group_name=None, privilege_ids=None, restricted=None, roles=None, username=None)

Bases: object

Implementation of the ‘UserParameters’ model.

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

Attributes:

additional_group_names (list of string): Array of Additional Groups.

Specifies the names of additional groups this User may belong to.

cluster_identifiers (list of ClusterIdentifier): Specifies the list of

clusters this user has access to. If this is not specified, access will be granted to all clusters.

description (string): Specifies a description about the user. domain (string): Specifies the fully qualified domain name (FQDN) of

an Active Directory or LOCAL for the default LOCAL domain on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.

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

milliseconds when the user becomes effective. Until that time, the user cannot log in.

email_address (string): Specifies the email address of the user. expired_time_msecs (long|int): Specifies the epoch time in

milliseconds when the user becomes expired. After that, the user cannot log in.

password (string): Specifies the password of this user. primary_group_name (string): Specifies the name of the primary group

of this User.

privilege_ids (list of int): Array of Privileges. Specifies the

Cohesity privileges from the roles. This will be populated based on the union of all privileges in roles.

restricted (bool): Whether the user is a restricted user. A restricted

user can only view the objects he has permissions to.

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

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

username (string): Specifies the login name of the user.

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.