models.user module

class models.user.User(additional_group_names=None, authentication_type=None, cluster_identifiers=None, created_time_msecs=None, description=None, domain=None, effective_time_msecs=None, email_address=None, expired_time_msecs=None, force_password_change=None, google_account=None, group_roles=None, idp_user_info=None, last_updated_time_msecs=None, org_membership=None, password=None, preferences=None, primary_group_name=None, privilege_ids=None, restricted=None, roles=None, s_3_access_key_id=None, s_3_account_id=None, s_3_secret_key=None, salesforce_account=None, sid=None, tenant_id=None, username=None)

Bases: object

Implementation of the ‘User’ model.

Specifies details about a user.

Attributes:

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

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

authentication_type (AuthenticationTypeUserEnum): Specifies the

authentication type of the user. ‘kAuthLocal’ implies authenticated user is a local user. ‘kAuthAd’ implies authenticated user is an Active Directory user. ‘kAuthSalesforce’ implies authenticated user is a Salesforce user. ‘kAuthGoogle’ implies authenticated user is a Google user. ‘kAuthSso’ implies authenticated user is an SSO user.

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.

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

milliseconds when the user account was created on the Cohesity Cluster.

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.

force_password_change (bool): Specifies whether to force user to

change password.

google_account (GoogleAccountInfo): Google Account Information of a

Helios BaaS user.

group_roles (list of string): Specifies the Cohesity roles to

associate with the user’ group. These roles can only be edited from group.

idp_user_info (IdpUserInfo): Specifies an IdP User’s information

logged in using an IdP. This information is not stored on the Cluster.

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

milliseconds when the user account was last modified on the Cohesity Cluster.

org_membership (list of TenantConfig): OrgMembership contains the list

of all available tenantIds for this user to switch to. Only when creating the session user, this field is populated on the fly. We discover the tenantIds from various groups assigned to the users.

password (string): Specifies the password of this user. preferences (Preferences): TODO: type description here. primary_group_name (string): Specifies the name of the primary group

of this User.

privilege_ids (list of PrivilegeIdUserEnum): Array of Privileges.

Specifies the Cohesity privileges from the roles. This will be populated based on the union of all privileges in roles. Type for unique privilege Id values. All below enum values specify a value for all uniquely defined privileges in Cohesity.

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.

s_3_access_key_id (string): Specifies the S3 Account Access Key ID. s_3_account_id (string): Specifies the S3 Account Canonical User ID. s_3_secret_key (string): Specifies the S3 Account Secret Key. salesforce_account (SalesforceAccountInfo): Salesforce Account

Information of a Helios user.

sid (string): Specifies the unique Security ID (SID) of the user. This

field is mandatory in modifying user.

tenant_id (string): Specifies the effective Tenant ID of the 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.