Object Classes

domain	String	The name of the Active Directory domain with which to synchronize users.
ipAddresses	DomainControlIPAddresses	A DomainControlIPAddresses object. This attribute is optional.
ou	String	The name of the organizational unit (OU) within the Active Directory domain with which to synchronize users. This attribute is optional.
idMapping	ADIDMapping	Active Directory user ID mappings, as an ADIDMapping object. This attribute is optional.
accessControlRules	AccessControlRule[]	An array of AccessControlRule objects. This attribute is optional.
trustedDomains	String[]	An array of trusted Active Directory domains. This attribute is optional.
useKerberos	Boolean	Set to true to use the Kerberos protocol for authentication when communicating with the Active Directory domain. This is useful for achieving Single Sign On (SSO) with Windows computers. If unchecked, LDAP is used. Note: Only one virtual portal, per system, can use Kerberos. The default value is false.
capaths	String	Defines the database used to construct the authentication paths between realms, when performing direct, non-hierarchical, cross-realm authentication. This attribute is optional.
useSSL	Boolean	Set to true to connect to the Active Directory domain using SSL. The default value is false. This attribute is optional.
noMatchRole	PortalRole	Defines the role that is applied when a user that does not match any of the users that are defined in the Access Control Lists connects to the portal. See PortalRole. The default value is Disabled.
searchBy	AlphaNumeric	A string to use for the search. The string can contain letters and numbers only. This attribute is optional.

Attributes Inherited from the Parent Class DirectoryConnector

type	DirectoryConnectorType	The type of Directory connector. See DirectoryConnectorType.
username	String	The user name for authenticating to the directory service.
password	password	The password for authenticating to the directory service.

ActiveDirectorySettings

This class is currently undocumented. For additional information, contact CTERA support.

ADDomainIDMapping

Represents the mappings from an Active Directory domain's SID identifiers to POSIX UID and GID numbers.

Attributes

domainFlatName	String	The domain name.
minID	Integer	The first number in the UID/GID range. The value must be between 1 and 2147483646.
maxID	Integer	The last number in the UID/GID range. The value must be between 2 and 2147483647.

XML Encoding Example

</att>

</att>

</att>

</obj>

AddOn

Represents an addon.

This class extends the BaseObject class.

Attributes

subscriptionPeriod	Integer	The number of days after the addon has been added to the user account that the addon will expire. This attribute is optional.
storage	AddonItem	An AddonItem object representing the amount of storage quota included in the addon. The default value is 0 storage quota.
serverAgents	AddonItem	An AddonItem object representing the number of server agents included in the addon. The default value is 0 server agents.
workstationAgents	AddonItem	An AddonItem object representing the number of workstation agents included in the addon. The default value is 0 workstation agents.
appliances	AddonItem	An AddonItem object representing the number of cloud storage gateways included in the addon. The default value is 0 cloud storage gateways.
vGateways4	AddonItem	An AddonItem object representing the number of virtual gateway EV4 licenses included in the addon. The default value is 0.
vGateways8	AddonItem	An AddonItem object representing the number of virtual gateway EV8 licenses included in the addon. The default value is 0.
vGateways32	AddonItem	An AddonItem object representing the number of virtual gateway EV32 licenses included in the addon. The default value is 0.
vGateways64	AddonItem	An AddonItem object representing the number of virtual gateway EV64 licenses included in the addon. The default value is 0.
cloudDrives	AddonItem	An AddonItem object representing the number of cloud drives included in the addon. The default value is 0 cloud drives.
cloudDrivesLite	AddonItem	An AddonItem object representing the number of Cloud Drive Connect licenses in the addon. The default value is 0 cloud drives.
services	PortalServiceStatus[]	An array of PortalServiceStatus objects. The default value is OK for all portal services. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

createVouchers

Creates vouchers for the addon.

XML Encoding Example

</att>

<val>10GB Online Backup</val>

</att>

</att>

</att>

<val>objs/2//ResellerPortal/ea</val>

</att>

</att>

</att>

</att>

<val>Server Agents</val>

</att>

</obj>

</att>

<list>

<val>Cloud Backup</val>

</att>

</att>

</obj>

<val>Cloud folders</val>

</att>

</att>

</obj>

<val>Cloud file sharing</val>

</att>

</att>

</obj>

<val>Seeding</val>

</att>

</att>

</obj>

<val>Remote Access</val>

</att>

</att>

</obj>

<val>Logging and Reporting</val>

</att>

</att>

</obj>

<val>Firmware Updates</val>

</att>

</att>

</obj>

<val>Management and Monitoring</val>

</att>

</att>

</obj>

</att>

</att>

</obj>

<val>CTERA Agents</val>

</att>

</att>

</obj>

<val>CTERA Agents</val>

</att>

</att>

</obj>

</list>

</att>

</att>

<val>Storage Quota</val>

</att>

</obj>

</att>

</att>

<val>Workstation Agents</val>

</att>

</obj>

</att>

</att>

<val>Appliances</val>

</att>

</obj>

</att>

</att>

<val>vGateways4</val>

</att>

</obj>

</att>

</att>

<val>Cloud Drives</val>

</att>

</obj>

</att>

</obj>

AddonItem

Represents information about an item included in an addon.

Attributes

name	PlanItemEnum	The item's type. See PlanItemEnum.
amount	Integer	The amount of storage space, number of workstation agents, or number of server agents.

XML Encoding Example

See the example for AddOn.

AddonParam

Represents a parameter of an addon.

Attributes

addon	String	The name of the addon that should be added.
externalItemId	String	An optional unique ID for this addon. This ID can later be referenced by client, in order to delete the addon.
comment	String	An optional comment describing the addon.

XML Encoding Example

</att>

</att>

<val>This addon is for xyz</val>

</att>

</obj>

AddonsStatisticsReport

Represents an addons Report.

This class extends the Report class.

Attributes

statistics

AddonStatistics[]

An array of AddonStatistics objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

XML Encoding Example

</att>

</att>

<val>addonsStatisticsReport</val>

</att>

<val>objs/11//ResellerPortal/vk1</val>

</att>

<list>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</list>

</att>

</att>

</obj>

AddonStatistics

Represents statistics for an addon in the Addons Report.

Attributes

portal	String	The name of the virtual portal in which this addon is defined.
name	String	The addon name.
amount	Integer	The number of addons that are currently in use.
addonStorage	Integer	The amount of storage space included in a single instance of this addon.
totalStorageQuota	Integer	The total amount of storage space included in all instances of this addon. For example, if the storage quota of a single instance of this addon is 10GB, and the addon is used 15 times, then the total storage space is 150GB.
totalServerAgents	Integer	The total number of server agent licenses included in all instances of this addon.
totalWSAgents	Integer	The total number of workstation agent licenses included in all instances of this addon.
totalAppliances	Integer	The total number of cloud storage gateway licenses included in all instances of this addon. This attribute is optional.
totalCloudDrives	Integer	The total number of Cloud Drive licenses included in all instances of this addon. This attribute is optional.

ADGroup

Represents an Active Directory group.

This class extends the Group class.

Attributes

sid

String

Active Directory domain's SID identifier.

This attribute is optional.

Attributes Inherited from the Parent Class Group

name	objNameWithSpaces	The name of the group. The minimum value is 1.
description	String	A description of the group. This attribute is optional.
membersCount	Integer	The number of users in the group. Calculated using the getMembersCount method and not when reading an objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods Inherited from the Parent Class Group

delete	Deletes the group.
getMembers	Retrieves the list of group members.
searchMembers	Searches for the specified members within the group.
updateGroup	Updates the group with members that were added to the group and deletes members that were removed from the group.

ADIDMapping

Represents a list of Active Directory ID mappings for multiple domains.

Attributes

map

ADDomainIDMapping[]

An array of ADDomainIDMapping objects.

XML Encoding Example

<list>

</att>

</att>

</att>

</obj>

</att>

</att>

</att>

</obj>

</list>

</att>

</obj>

ADSearchResult

Represents an Active Directory user or group.

Attributes

domain	String	The Active Directory domain name. This attribute is optional.
type	String	The search result's type. This can have the following values: user. A user. group. A user group.
name	String	The user or user group's name (SamAccountName).
dn	String	The user or user group's DN.
fullName	String	The user or user group's full name. This attribute is optional.
email	String	The user or user group's email address. This attribute is optional.
rid	String	The user or user group's Active Directory relative identifier (RID). This attribute is automatically calculated from the active directory. This attribute is optional.
firstName	String	The user or user group's first name. This attribute is optional.
lastName	String	The user or user group's last name. This attribute is optional.

XML Encoding Example

<val>CN=Dave Oren,OU=ou1,DC=ctera,DC=com</val>

</att>

<val>ctera.com</val>

</att>

</att>

</att>

</obj>

ADUser

Represents an Active Directory user.

This class extends the PortalEndUser class.

Attributes

name	objNameWithNonAsciiWithSpace	The Active Directory user defined as a portal end user. This value must be between 1 and 255 characters.
sid	String	Active Directory domain's SID identifier. This attribute is optional.

Attributes Inherited from the Parent Class PortalEndUser

role	PortalRole	The end user's role. See PortalRole. The default value is EndUser.
groups	ref[]	An array of links to user groups to which the end user belongs. This attribute is optional.
address	BillingAddress	A BillingAddress object. This attribute is optional.
secondaryUsername	String	An additional username or passcode, for cases in which an additional authentication step is required other than the user name and password. This attribute is optional.
billingId	String	The user's billing ID. The attribute is relevant for reseller portals only. It is optional.
externalAccountId	String	The user's ID in an external billing system. This attribute is optional.
plan	Ref	A link to the end user's assigned plan. This attribute is optional.
assignedPlan	Ref	A link to the end user's assigned plan. This attribute is optional and is inherited from the plan attribute.
addOns	UserAddOn[]	An array of UserAddOn objects. This attribute is optional.
userStats	PortalUserStats	A PortalUserStats object.
accountStatus	AccountStatus	The account's status. See AccountStatus. The default value is active.
calculatedAccountStatus	CalculatedAccountStatus	The calculated account status. See CalculatedAccountStatus. The default value is active. This attribute is optional.
creditCard	CreditCard	A CreditCard object. This attribute is relevant for reseller portals only. It is optional.
expirationDate	Date	Expiration date for the user subscription. This attribute is optional. It is only relevant if the user is assigned to a time-limited trial plan.
expired	Boolean	This attribute is set to true if the user plan has expired. This attribute is calculated automatically based on the expirationDate attribute. The default value is false.
userExpirationDate	Date	Expiration date for the user account. This attribute is optional.
userExpired	Boolean	This attribute is set to true if the user account has expired. This attribute is calculated automatically based on the userExpirationDate attribute. The default value is false.
planOptions	PlanOptions	A PlanOptions object. This attribute is optional.
sla	EffectiveSLA	The service level of this user, represented by an EffectiveSLA object. This attribute is optional.
calculatedSla	EffectiveSLA	The service level of this user, represented by an EffectiveSLA object. This is calculated automatically. This attribute is optional.
anniversaryDate	Date	The billing anniversary date. Invoices are sent monthly or annually, starting from this date. This attribute is relevant for reseller portals only. This attribute is optional.
defaultBackupGroup	Ref	A link to the default backup folder group to use for all new devices attached to this user account. This attribute is optional.
defaultCloudDriveGroup	Ref	A link to the default cloud drive folder group to use for all new devices attached to this user account. This attribute is optional.
backupCooperativeDedup	TeamPortalDeduplicationLevel	The level at which deduplication of backups is performed. See TeamPortalDeduplicationLevel. The default value is user.
cloudDriveCooperativeDedup	TeamPortalDeduplicationLevel	The level at which deduplication of cloud drive folders is performed. See TeamPortalDeduplicationLevel. The default value for reseller portals is user. The default value for team portals is portal.
homeFolder	Ref	A link to the home folder in which the cloud drive files should be stored for this user account. This attribute is optional.
uuid	Integer	The user's globally unique ID. This attribute is optional.
generateReportDisabled	Boolean	Set this attribute to true to indicate that the user should receive customer reports. Otherwise, set this attribute to false. This attribute is optional.

Attributes Inherited from the Parent Class BaseUser

name	objNameWithNonAscii	The user's user name.
firstName	String	The user's first name.
lastName	String	The user's last name.
email	String	The user's email address.
userAvatarName	String	The user's avatar name.
company	String	The user's company. This attribute is optional.
lastReportSentDate	Date	The date on which a report was last sent to this user. This attribute is optional.
notificationCategories	NotificationCategories	A NotificationCategories object.
lastLogin	dateTime	The date on which the user last logged in. This attribute is optional.
language	Language	The user's language. See Language. The default value is the value of the Interface Language setting under Default Settings for New Users in the Virtual Portal Settings page of the portal web interface.
passwordsHistory	PasswordsHistoryParams	An array of the user's previous passwords. See PasswordsHistoryParams.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods Inherited from the Parent Class PortalEndUser

activateDevice	Activates one of the user's devices.
addAddon	Adds an addon to this user. See Adding an Addon to a Portal User.
addVoucher	Adds a voucher to this user.
answerCaptcha	Returns an answer to a captcha submission.
answerRecoverCaptcha	Returns an answer to a captcha submitted by the user recovering the password.
attachDevice	Attaches a device to the user's account.
changeEmailRequest	Changes the user's email.
delete	Deletes the end user from the portal.
deleteAllFolders	Deletes all folders associated with this user.
generateReport	Generates an end user report for this user. See Generating Reports.
getDevicesDetails	Retrieves information about all devices associated with this user.
getInvitations	Retrieves all invitations sent by the user.
getInvoice	Retrieves this user's latest invoice.
getLastModifiedOfFiles	Retrieves the last modified versions of files.
recoverPassword	Recovers the user's password.
recoverPasswordChange	Returns an answer to a recover password request submitted by the user.
removeAddon	Removes an addon from this user. See Removing an Addon from a Portal User.
searchMembers	Searches users in the database.
subscribe	Sets the user's plan. See Setting the Plan of a Portal User.
unsubscribe	Unsubscribes this user from their current plan.
validatePassword	Validates this user's password.
validateVoucher	Validates a voucher for this user.

Extended Methods Inherited from the Parent Class BaseUser

attachDevice	Associates a device with a user.
attachMobileDevice	Associates a mobile device with a user.
changeEmailRequest	Changes the email address associated with a user.
delete	Deletes a user.
recoverPassword	Recovers a user's password.
recoverPasswordChange	Changes a user's password.

AlertRule

Represents a rule for sending an email alert.

Attributes

id	String	The email alert's name.
description	String	The email alert's description. This attribute is optional.
logName	String	The name of the log that should trigger the email alert. This attribute is optional.
topic	LogTopic	The category of logs that should trigger the email alert. See LogTopic. This attribute is optional.
originType	OriginType	The entity from which a log must originate in order to trigger the email alert. See OriginType. This attribute is optional.
minSeverity	LogSeverity	The minimum severity a log must have in order to trigger the email alert. See LogSeverity. This attribute is optional.
messageContent	String	The text that the log message must contain in order to trigger the email alert. This attribute is optional.

XML Encoding Example

<val>portal system error</val>

</att>

<val>portal system error</val>

</att>

<val>error</val>

</att>

<val>Portal</val>

</att>

<val>system</val>

</att>

</obj>

ApplicationsTopic

Represents information about applications that should be backed up, for devices assigned to a specific device configuration template.

This class extends the ConfigTopic class.

Attributes

includeApps

BackupSet

A BackupSet object.

The default value is an empty set of applications.

Attributes Inherited from the Parent Class ConfigTopic

overrideTemplate

Boolean

Set this attribute to true to override the template settings. Otherwise, set this attribute to false to use the template settings.

The default value is false.

Backup

Represents a backup folder.

This class extends the CloudFolder class.

Attributes

devices

ref[]

An array of links to devices that back up to the backup folder.

This attribute is optional. There can only be one device per folder.

Attributes Inherited from the Parent Class CloudFolder

folderStats	FolderStats	A FolderStats object. The default value is 0 MB and 0 total files. The value is automatically calculated. This attribute is optional.
group	Ref	A link to the folder group to which the folder belongs. This attribute is optional.
enableBackupExtendedAttributes	Boolean	Set this attribute to true to back up special file permissions and metadata. Otherwise, set this attribute to false. This attribute is optional.
groupEncryptionMode	EncryptionMode	The mode to use for encrypting data in the folder group to which the folder belongs. See EncryptionMode. This attribute is optional.
isDeleted	Boolean	Set this attribute to true to specify that this folder was deleted. The default value is false.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

isAssignedToDevice

Indicates whether the backup folder is assigned to a device.

Extended Methods Inherited from the Parent Class CloudFolder

bringFolderOnline	Brings the cloud folder online. When the cloud folder is online, it is possible to view, modify, and back up files to it.
closeSnapshot	Closes the snapshot of this cloud folder.
consolidateSnapshots	Runs the snapshot consolidator on this cloud folder, to delete old snapshots that no longer need to be retained, according to the configured retention policy.
delete	Deletes the cloud folder.
deleteFolderPermanently	Deletes the cloud folder permanently.
exportFolder	Exports the folder.
exportNFSFolder	Exports the folder using NFS (Network File System) protocol.
exportS3Folder	Exports the folder using S3 (Amazon Simple Storage Service) protocol.
getStatistics	Retrieves statistics for the cloud folder.
importFolder	Imports the specified folder.
inviteNew	Sends an invitation to view the cloud folder's contents.
invitePublic	Sends a public invitation to view the cloud folder's contents.
isAssignedToDevice	Specifies whether the folder is assigned to a device.
listSnapshots	Lists all snapshots for the cloud folder.
listVersions	Lists the versions of this folder on the cloud.
listVersionsForAppliance	Lists the versions of this folder on the gateway.
restoreFiles	Restores files from the cloud folder.
undeleteFolder	Restores a cloud folder that was previously deleted.
validatePassword	Validates a user's passphrase for accessing the cloud folder.

BackupPolicy

Represents a backup policy.

Attributes

includeSets	BackupSet[]	An array of BackupSet objects. The default value is an empty set.
excludeSets	BackupSet[]	An array of BackupSet objects. The default value is a set including temporary files.

BackupPolicyTemplate

Represents a backup policy template.

This class extends the BackupPolicy class.

Attributes

includeSets	BackupSet[]	An array of BackupSet objects. The default value is an empty set. This attribute is inherited from the BackupPolicy class. It is optional.
excludeSets	BackupSet[]	An array of BackupSet objects. The default value is a set including temporary files. This attribute is inherited from the BackupPolicy class. It is optional.

BackupSet

Represents a backup set.

Attributes

name	String	The backup set's name.
directoryTree	DirEntry	A DirEntry object. The default value is the root node of the tree.
defaultDirs	String[]	An array of the default folders that are backed up. This attribute is optional.
templateDirectories	String[]	An array of files and folders to which this backup set applies. This attribute is optional.
isEnabled	Boolean	Set this attribute to true to indicate that the backup set is enabled and should be used during backup operations. Otherwise, set this attribute to false. The default value is true.
comment	String	A comment about the backup set. The attribute is optional.
filterRules	FilterRule[]	An array of FilterRule objects. The attribute is optional.
booleanFunction	BooleanFunction	The Boolean operator to use between conditions. See BooleanFunction The default value is AND.

BackupTemplate

Represents a backup device configuration template.

Attributes

scheduleTopic	ScheduleTopic	A ScheduleTopic object. This attribute is optional.
throttlingTopic	ThrottlingTopic	A ThrottlingTopic object. This attribute is optional.
backupPolicy	BackupPolicyTemplate	A BackupPolicyTemplate object. This attribute is optional.
applicationsTopic	ApplicationsTopic	An ApplicationsTopic object. This attribute is optional.

BaseObject

Represents a CTERA Portal basic object. This object class cannot be used directly. It is used only by other classes extending this class.

Attributes

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.

BaseUser

Represents a CTERA Portal basic user object. This object class cannot be used directly. It is used only by other classes extending this class.

This class extends the BaseObject class.

Attributes

name	objNameWithNonAscii	The user's user name.
firstName	String	The user's first name.
lastName	String	The user's last name.
email	email	The user's email address.
userAvatarName	String	The user's avatar name.
company	String	The user's company. This attribute is optional.
lastReportSentDate	Date	The date on which a report was last sent to this user. This attribute is optional.
notificationCategories	NotificationCategories	A NotificationCategories object.
lastLogin	dateTime	The date on which the user last logged in. This attribute is optional.
language	Language	The user's language. See Language. The default value is the value of the Interface Language setting under Default Settings for New Users in the Virtual Portal Settings page of the portal web interface.
passwordsHistory	PasswordsHistoryParams	An array of the user's previous passwords. See PasswordsHistoryParams.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

attachDevice	Associates a device with a user.
attachMobileDevice	Associates a mobile device with a user.
changeEmailRequest	Changes the email address associated with a user.
delete	Deletes a user.
recoverPassword	Recovers a user's password.
recoverPasswordChange	Changes a user's password.

BillingAddress

Represents an end user's billing address.

Attributes

street	String	The end user's street.
city	String	The end user's city.
country	CountryCode	The country code of the end user's country. See CountryCode.
state	String	The end user's state. This attribute is optional.
zipCode	String	The end user's zip code.

CliCommandTemplate

This class is currently undocumented. For additional information, contact CTERA support.

CloudDrive

Represents a cloud drive folder.

This class extends the CloudFolder class.

Attributes

name	noSlashStr	The name of the cloud drive folder.
description	String	A description of the cloud drive folder. This attribute is optional.
acl	ProjectACLRule[]	An array of ProjectACLRule objects. This attribute is optional.
cloudDriveType	CloudDriveType	The type of cloud drive folder. See CloudDriveType. The default value is Personal.

Attributes Inherited from the Parent Class CloudFolder

folderStats	FolderStats	A FolderStats object. The default value is 0 MB and 0 total files. The value is automatically calculated. This attribute is optional.
group	Ref	A link to the folder group to which the folder belongs. This attribute is optional.
enableBackupExtendedAttributes	Boolean	Set this attribute to true to back up special file permissions and metadata. Otherwise, set this attribute to false. This attribute is optional.
groupEncryptionMode	EncryptionMode	The mode to use for encrypting data in the folder group to which the folder belongs. See EncryptionMode. This attribute is optional.
isDeleted	Boolean	Set this attribute to true to specify that this folder was deleted. The default value is false.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods Inherited from the Parent Class CloudFolder

bringFolderOnline	Brings the cloud folder online. When the cloud folder is online, it is possible to view, modify, and back up files to it.
closeSnapshot	Closes the snapshot of this cloud folder.
consolidateSnapshots	Runs the snapshot consolidator on this cloud folder, to delete old snapshots that no longer need to be retained, according to the configured retention policy.
delete	Deletes the cloud folder.
deleteFolderPermanently	Deletes the cloud folder permanently.
exportFolder	Exports the folder.
exportNFSFolder	Exports the folder using NFS (Network File System) protocol.
exportS3Folder	Exports the folder using S3 (Amazon Simple Storage Service) protocol.
getStatistics	Retrieves statistics for the cloud folder.
importFolder	Imports the specified folder.
inviteNew	Sends an invitation to view the cloud folder's contents.
invitePublic	Sends a public invitation to view the cloud folder's contents.
isAssignedToDevice	Specifies whether the folder is assigned to a device.
listSnapshots	Lists all snapshots for the cloud folder.
listVersions	Lists the versions of this folder on the cloud.
listVersionsForAppliance	Lists the versions of this folder on the gateway.
restoreFiles	Restores files from the cloud folder.
undeleteFolder	Restores a cloud folder that was previously deleted.
validatePassword	Validates a user's passphrase for accessing the cloud folder.

Extended Methods

manageCloudDrive

Manages the ACLs for the cloud drive folder.

CloudDrivePolicyRule

This class is currently undocumented. For additional information, contact CTERA support.

CloudFolder

Represents a cloud folder.

This class extends the BaseObject class.

Attributes

folderStats	FolderStats	A FolderStats object. The default value is 0 MB and 0 total files. The value is automatically calculated. This attribute is optional.
group	Ref	A link to the folder group to which the cloud folder belongs. This attribute is optional.
enableBackupExtendedAttributes	Boolean	Set this attribute to true to back up special file permissions and metadata. Otherwise, set this attribute to false. The default value is true.
groupEncryptionMode	EncryptionMode	The mode to use for encrypting data in the folder group to which the folder belongs. See EncryptionMode. This attribute is optional.
isDeleted	Boolean	Set this attribute to true to specify that this folder was deleted. The default value is false.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

bringFolderOnline	Brings the cloud folder online. When the cloud folder is online, it is possible to view, modify, and back up files to it.
closeSnapshot	Closes the snapshot of this cloud folder.
consolidateSnapshots	Runs the snapshot consolidator on this cloud folder, to delete old snapshots that no longer need to be retained, according to the configured retention policy.
delete	Deletes the cloud folder.
deleteFolderPermanently	Deletes the cloud folder permanently. Warning: You cannot restore the folder after it is deleted.
exportFolder	Exports the folder.
exportNFSFolder	Exports the folder using NFS (Network File System) protocol.
exportS3Folder	Exports the folder using the S3 (Amazon Simple Storage Service) protocol.
getStatistics	Retrieves statistics for the cloud folder.
importFolder	Imports the specified folder.
inviteNew	Sends an invitation to view the cloud folder's contents.
invitePublic	Sends a public invitation to view the cloud folder's contents.
isAssignedToDevice	Specifies whether the folder is assigned to a device.
listSnapshots	Lists all snapshots for the cloud folder.
listVersions	Lists the versions of this folder on the cloud.
listVersionsForAppliance	Lists the versions of this folder on the gateways.
restoreFiles	Restores files from the cloud folder.
undeleteFolder	Restores a cloud folder that was previously deleted.
validatePassword	Validates a user's passphrase for accessing the cloud folder.

ConfigTopic

This is the base class for configuration template topics. Do not use this class directly; instead use the following classes that extend this class:

ApplicationsTopic

ScheduleTopic

ThrottlingTopic

Attributes

overrideTemplate

Boolean

Set this attribute to true to override the template settings. Otherwise, set this attribute to false to use the template settings.

The default value is false.

CreditCard

Represents an end user's credit card details.

This class is relevant for reseller portals only, and only if credit card billing is enabled.

Attributes

name	String	The name appearing on the credit card.
cardNumber	String	The credit card number.
expirationMonth	Integer	The credit card expiration month. The value must be between 1 and 12.
expirationYear	Integer	The credit card expiration year.
securityCode	String	The three-digit card security code appearing on the back of the credit card.

CteraPhoneNumber

Represents the phone number to which a security code for a portal invitation is sent in a text message.

Attributes

phoneNumber	phoneNumber	The phone number.
phoneNumberRegion	String	The country code. This attribute is optional.
nationalFormat	String	The area code. This attribute is optional.

CustomizedTemplate

Represents a custom email notification template.

Attributes

portal	Ref	A link to the portal in which the custom template is defined. This attribute is optional.
name	String	The name of the custom template.
displayName	String	The custom template's name as displayed in the CTERA Portal.
sendFormat	SendFormat	The format in which to send the email notification. See SendFormat.
subject	String	The text that should appear in the notification email's Subject line. This attribute is optional.
body	String	The text that should appear in the notification email's body.
pdf	String	A link to the PDF-ed message. This attribute is optional.
customised	Boolean	Set this attribute to true to indicate that the template has been customized. Otherwise, set this attribute to false.
standAlone	Boolean	Set this attribute to true if this template is an email notification template that can be previewed in the Web interface. Set this attribute to false if the template is a snippet to be included in other notifications and cannot be previewed in the Web interface.

DailySchedule

Represents a schedule for automatically backing up files every day.

Attributes

days	DayOfWeek[]	An array of DayOfWeek objects. This attribute is optional.
hour	Integer	The hour at which the task should be executed. The value must be between 0 and 23.
minute	Integer	The minute at which the task should be executed. The value must be between 0 and 59.

DevicesStatisticsReport

Represents a Devices Report.

This class extends the Report class.

Attributes

statistics

DeviceStatistics[]

An array of DeviceStatistics objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

XML Encoding Example

</att>

</att>

<val>devicesStatisticsReport</val>

</att>

<val>objs/11//ResellerPortal/vk1</val>

</att>

<list>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</list>

</att>

</att>

</obj>

DeviceStatistics

Represents statistics for a device in the Devices Report.

Attributes

portal	String	The name of the virtual portal in which this device is defined.
deviceType	String	The device type.
amount	Integer	The number of devices of this type.
connected	Integer	The number of devices of this type that are currently connected to the CTERA Portal.
notConnected	Integer	The number of devices of this type that are currently not connected to the CTERA Portal.
totalLocalStorage	Integer	The total amount of local storage space reported by devices of this type.
freeLocalStorage	Integer	The amount of local storage space that is currently reported as unused by devices of this type.

DeviceTemplate

Represents a device configuration template.

This class extends the BaseObject class.

Attributes

firmwaresSettings	FirmwaresSettings	A FirmwaresSettings object. The default value is to use the global settings for the firmwares, for all devices assigned to this template.
deviceSettings	DeviceTemplateSettings	A DeviceTemplateSettings object.
isDefault	Boolean	Set this attribute to true to make this the default device configuration template. Otherwise, set this attribute to false. The default value is false.
description	String	A description of the device configuration template. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

delete	Deletes the device configuration template.
setAsDefault	Sets the device configuration template as the default template.

DeviceTemplateAutoAssignmentRule

Represents a rule in an automatic template assignment policy.

Attributes

filterRule	FilterRule	A FilterRule object.
Template	Ref	A link to the device configuration template that should be assigned when the rule's conditions are met.

DeviceTemplateSettings

Represents a device configuration template's settings.

Attributes

backup	BackupTemplate	A BackupTemplate object.
softwareUpdates	SoftwareUpdatesTopic	A SoftwareUpdatesTopic object. This attribute is optional.
foldersListTopic	FoldersListTopic	A FoldersListTopic object. This attribute is optional.
cliCommands	CliCommandTemplate	A CliCommandTemplate object. This attribute is optional.
syncThrottlingTopic	SyncThrottlingTopic	A SyncThrottlingTopic object. This attribute is optional.
scripts	ScriptsTemplates	A ScriptsTemplates object. This attribute is optional.

DirectoryConnector

Represents a set of credentials for authenticating to a directory service.

Attributes

type	DirectoryConnectorType	The type of directory with which to integrate CTERA Portal. See DirectoryConnectorType.
username	String	The user name that CTERA Portal should use for authenticating to a directory service.
password	password	The password that CTERA Portal should use for authenticating to a directory service.

DirEntry

Represents a directory entry.

This class extends the FileEntry class.

Attributes

children	FileEntry[]	An array of FileEntry objects. This attribute is optional. It is case-sensitive.
name	String	The entry's name. This attribute is inherited from the FileEntry class.
displayName	String	The entry's name, as displayed in the portal. This attribute is inherited from the FileEntry class. It is optional.
isIncluded	Boolean	Set this attribute to true to indicate that the entry is included in the backup set. Otherwise, set this attribute to false. This attribute is inherited from the FileEntry class. It is optional.

Domain

Represents an Active Directory domain.

Attributes

name	String	The domain's name.
adUsers	ADUser[]	An array of ADUser objects. This attribute is optional.
adGroups	ADGroup[]	An array of ADGroup objects. This attribute is optional.

DomainControlIPAddresses

Represents a pair of primary and secondary Active Directory domain controller IP addresses.

Attributes

ipAddress1	String	An IP address of the primary Active Directory domain controller.
ipAddress2	String	An IP address of a secondary Active Directory domain controller. This attribute is optional.

EffectiveSLA

Represents the current provisioned service level agreement (SLA) of a user or portal. It is calculated according to the user or portal's plans and addons.

Attributes

calculatedQuota	Integer	The storage quota of the account in GB. This attribute is optional.
calculatedServerAgents	Integer	The account's quota of server agents. This attribute is optional.
calculatedWorkstationAgents	Integer	The account's quota of workstation agents. This attribute is optional.
calculatedAppliances	Integer	The account's quota of cloud storage gateways. This attribute is optional.
calculatedVGateway4	Integer	The account's quota of virtual gateways with an EV4 license. This attribute is optional.
calculatedVGateway8	Integer	The account's quota of virtual gateways with an EV8 license. This attribute is optional.
calculatedVGateway32	Integer	The account's quota of virtual gateways with an EV32 license. This attribute is optional.
calculatedVGateway64	Integer	The account's quota of virtual gateways with an EV64 license. This attribute is optional.
calculatedCloudDrives	Integer	The account's quota of cloud drives. This attribute is optional.
calculatedCloudDrivesLite	Integer	The account's quota of cloud drive Connect licenses. This attribute is optional.
zeroQuotaSince	Date	The date since which the user has no storage quota remaining on their account. This attribute is optional.
noCloudFolderServiceSince	Date	The date since which the cloud folder service has been down. This attribute is optional.
noCloudBackupServiceSince	Date	The date since the cloud backup service has been deprovisioned for this user. This attribute is optional.
hasCloudBackupServiceSince	Date	The last date on which the cloud backup service was active. This attribute is optional.
services	PortalServiceStatus[]	An array of PortalServiceStatus objects. This attribute is optional.
warning	SLAWarning	A warning message to display to the user. See SLAWarning. This attribute is optional.
deletionTime	Integer	The date on which the user’s files are scheduled to be deleted, based on the value of the PortalSettings class's autoDeleteZeroQuotaFiles attribute. This attribute is optional.

ExportFolderParams

Folder contents to either export or scan for viruses.

Attributes

paths	string[]	An array of folders to export or scan.
destFolder	string	The destination folder for the exported paths. When scanning for viruses this value must be an empty string, as follows: <att id="destFolder"> <val/> </att>
type	SeedingExportType	The type of the result of a folder export: normal – The folder contents are copied to the destination folder as is. tar – The folder contents are copied to the destination folder as a tar file. zip – The folder contents are copied to the destination folder as a zip file. split – The folder contents are copied to the destination folder in an optimized fashion between zipping and not. This attribute is optional. Set to normal when scanning for viruses.
snapshot	string	A snapshot identifier. This attribute is optional.
passphrase	string	The folder’s passphrase.
endUserPassword	string	The user’s password. An administrator who cannot view the user files must enter a value.
useSingleQuery	boolean	For exporting folders. Set to true when scanning for viruses.

FileEntry

Represents a file entry.

Attributes

name	String	The entry's name.
displayName	String	The entry's name, as displayed in the portal. This attribute is optional.
isIncluded	Boolean	Set this attribute to true to indicate that the entry is included in the backup set. Otherwise, set this attribute to false. This attribute is optional.

FilterRule

This class is currently undocumented. For additional information, contact CTERA support.

FirmwaresSettings

Represents firmware settings for a device configuration template.

Attributes

useGlobal	Boolean	Set this attribute to true to use the global settings for firmwares. Otherwise, set this attribute to false. The default value is true.
firmwares	TemplateFirmware[]	An array of TemplateFirmware objects. This attribute is optional.

FoldersGroup

Represents a folder group.

This class extends the BaseObject class.

Attributes

disabled	Boolean	Set this attribute to true to disable the folder group. Otherwise, set this attribute to false. The default value is true.
cloudFSVersion	Integer	The cloud storage encoding scheme to use for the folder group. The default value is 2.
encryptionMode	EncryptionMode	The method to use for encrypting data in this folder group. See EncryptionMode.
encryptedFolderKey	String	The folder encryption key, encrypted by the user's secret passphrase. This attribute is optional.
checkCode	String	A cryptographic code used for verifying the correctness of the specified passphrase. This attribute is optional.
passPhraseSalt	String	A cryptographic salt value. This attribute is optional.
averageBlockSizeKb	Integer	The default average block size used by new folder groups in Kb. This value must be between 16 and 4096. The default value is 512.
averageMapFileSizeKb	Integer	The default average map file size used by new folder groups. in Kb. The default value is 640000.
shouldCompress	Boolean	Set this attribute to true to require devices to compress all blocks that they upload to the portal. Otherwise, set this attribute to false. The default value is true.
compressionMethod	CompressionMethod	The compression method that devices should use for blocks uploaded to the portal. See CompressionMethod. The default value is HighCompression. This attribute is optional.
shouldEncrypt	Boolean	Set this attribute to true to store data in this folder group in encrypted format. Otherwise, set this attribute to false. The default value is true.
minimumMapFileBlocks	Integer	The minimum number of deduplication blocks that a file in this folder group must contain in order to trigger creation of a mapfile object. Files with less than this amount will not create a mapfile object, and instead store the list of blocks directly in the database. The minimum number of deduplication blocks that a file must contain in order to trigger creation of a mapfile. The default value is 1. Tip: For backwards compatibility with firmware versions earlier than 3.1, set this field's value to 1.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

changePassphrase	Changes the folder group's passphrase.
deleteGroup	Deletes the folder group.
disableFileStatistics	Disables statistics per file.
enableFileStatistics	Enables statistics per file, for debug purposes.
getDevicesOfGroup	Retrieves all devices that upload data to this folder group.
setOfflineState	Takes the folder group offline. When offline, it is not possible to view, modify, and back up files to the folder group.
validatePassword	Validates the folder group's passphrase.

FolderGroupStatistics

Represents statistics for a folder group in the Folder Groups Report.

Attributes

folderGroupName	String	The folder group's name.
owner	String	The folder group's owner. This attribute is optional.
isDeleted	Boolean	Set to true to indicate that the folder group has been deleted.
blocksStorageSpace	Integer	The amount of storage space consumed by this folder group. This attribute is optional.
mapFileOverhead	Integer	The amount of space consumed by the mapfiles for this folder group in MB.
uncompressedSize	Integer	The uncompressed size of the files in folders belonging to this folder group in MB. This attribute is optional.
inUploadSize	Integer	The size of files that are currently being uploaded to folders belonging to this folder group in MB.
numberOfFolders	Integer	The number of folders belonging to this folder group. This attribute is optional.
uploadedBlocks	Integer	The number of uploaded blocks in folders belonging to this folder group. This attribute is optional.
inUploadBlocks	Integer	The number of blocks currently being uploaded to folders belonging to this folder group. This attribute is optional.
inUploadMapFiles	Integer	The number of mapfiles currently being uploaded to folders belonging to this folder group. This attribute is optional.
missingBlocks	Integer	The number of missing blocks in folders belonging to this folder group. This attribute is optional.
totalMapfiles	Integer	The total number of mapfiles in folders belonging to this folder group. This attribute is optional.
missingMapfiles	Integer	The number of missing mapfiles in folders belonging to this folder group. This attribute is optional.
totalFiles	Integer	The total number of files in folders belonging to this folder group. This attribute is optional.
inUploadFiles	Integer	The number of files that are currently being uploaded to folders belonging to this folder group. This attribute is optional.
badFiles	Integer	The number of corrupted files in folders belonging to this folder group. This attribute is optional.

FolderGroupsStatisticsReport

Represents a Folder Groups Report.

This class extends the Report class.

Attributes

statistics

FolderGroupStatistics[]

An array of FolderGroupStatistics objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

XML Encoding Example

</att>

</att>

<val>folderGroupsStatisticsReport</val>

</att>

<val>objs/11//ResellerPortal/vk1</val>

</att>

<list>

</att>

</att>

<val>vk-CloudFolders1</val>

</att>

</att>

</att>

</att>

</att>

<val>false</val>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</att>

</att>

<val>rrrrrr</val>

</att>

</att>

</att>

</att>

</att>

<val>false</val>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</list>

</att>

</att>

</obj>

FoldersListTopic

This class is currently undocumented. For additional information, contact CTERA support.

FolderStatistics

Represents statistics for a folder in the Folders Report.

Attributes

folderUID	String	The folder's unique ID.
folderName	String	The folder's name.
type	String	The type of folder, such as backup folder or home folder.
owner	String	The folder's owner. This attribute is optional.
isDeleted	Boolean	Set to true to indicate that the folder has been deleted.
currentSnapshotSize	Integer	The size of the current snapshot in MB. This attribute is optional.
allSnapshotsSize	Integer	The size of all snapshots of this folder in MB. This attribute is optional.
inUploadSize	Integer	The size of files that are currently being uploaded to this folder in MB. This attribute is optional.
currentSnapshotFiles	Integer	The number of files in the current snapshot (that is, not including previous versions that are stored for this folder). This attribute is optional.
allSnapshotsFiles	Integer	The total number of files in all snapshots (that is, including previous versions that are stored for this folder). This attribute is optional.
inUploadFiles	Integer	The number of files that are currently being uploaded to this folder. This attribute is optional.
badFiles	Integer	The number of corrupted files in the folder. This attribute is optional.
snapshotCount	Integer	The number of previous versions currently stored for this folder.

FoldersStatisticsReport

Represents a Folders Report.

This class extends the Report class.

Attributes

statistics

FolderStatistics[]

An array of FolderStatistics objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

XML Encoding Example

</att>

</att>

<val>foldersStatisticsReport</val>

</att>

<val>objs/11//ResellerPortal/alvi1</val>

</att>

<list>

</att>

</att>

</att>

</att>

</att>

<val>alvi-CloudFiles2</val>

</att>

</att>

</att>

<val>false</val>

</att>

</att>

</att>

<val>HomeFolder</val>

</att>

</obj>

</list>

</att>

</att>

</obj>

FolderStats

Represents statistics for a folder.

Attributes

cloudFolderSize	Integer	The current size of the folder in MB. This attribute is optional.
totalFiles	Integer	The total number of files in the folder. This attribute is optional.
infectedFiles	Integer	The total number of files in the folder for which a threat was detected. This attribute is optional.
currentSnapshot	Snapshot	A Snapshot object. This attribute is optional.
lastSuccessfulSnapshot	Snapshot	A Snapshot object. This attribute is optional.
mode	CloudFolderMode	The cloud folder mode. See CloudFolderMode. This attribute is optional.

Group

Represents a user group.

This class extends the BaseObject class.

Attributes

name	objNameWithSpaces	The name of the group. The minimum value is 1.
description	String	A description of the group. This attribute is optional.
membersCount	Integer	The value for this field is NULL. The number of users in the group is calculated using the getMembersCount method.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

delete	Deletes the group.
getMembers	Retrieves the list of group members.
getMembersCount	Retrieves the number of users in the group.
searchMembers	Searches for the specified members within the group.
updateGroup	Updates the group with member that were added to the group and deletes members that were removed from the group.

HomeFolderSettings

Attributes

enableHomeFolders	Boolean	Set this attribute to true to specify that one personal folder is automatically created for each new user account. The default value is true.
homeFolderName	noSlashStr	The name of the personal folder automatically created for each new user account. The default value is myfiles.
attachmentsFolderName	noSlashStr	The name of the Attachments folder automatically created for each new user account. The default value is Sent Attachments.

HourlySchedule

Represents a schedule for automatically backing up files every hour.

Attributes

minute

Integer

The minute at which the task should be executed.

The value must be between 0 and 59.

Invoice

Represents an invoice.

This class extends the BaseObject class. It is relevant for reseller portals only.

Attributes

user	Ref	A link to the user account to which the invoice applies.
fixedUserData	PortalEndUser	A PortalEndUser object.
startBillingPeriod	Date	A date representing the start of the billing period.
endBillingPeriod	Date	A date representing the end of the billing period.
balance	Currency	The amount of money due to be paid.
dueDate	Date	The date on which the payment is due. This attribute is optional.
paymentDate	Date	The date on which payment was made. This attribute is optional.
billingMode	BillingMode	The billing mode. See BillingMode. The default value is manual.
isCancelled	Boolean	Set to true to cancel the invoice. The default value is false.
billingAttemptsCount	Integer	The number of attempts made to process the invoice. This attribute is optional. The default value is 0.
LastBillingAttemptTime	Date	The date on which the last attempt to process the invoice was made. This attribute is optional.
lastBillingAttempResult	String	The result of processing the invoice, as returned by the credit card company. This attribute is optional.
invoiceDetails	InvoiceComponent[]	An array of InvoiceComponent objects. This attribute is optional.
status	InvoiceStatus	The invoice's status. See InvoiceStatus. This attribute is optional.
fullCycleBalance	Currency	The total plan price per billing cycle.
partialBalance	Currency	The required payment for this invoice. If this is a partial billing cycle, this is less than the value of fullCycleBalance. This attribute is optional.
rebate	Currency	The amount to refund for pre-paid services, if this is a partial invoice due to plan change during the billing cycle. This attribute is optional.
rebateDays	Integer	The amount of unused and pre-paid days for which refund applies, if this is a partial invoice due to plan change during the billing cycle. This attribute is optional.
transactionId	String	The invoice's associated credit card transaction ID, if already paid. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

chargeNow	Charges the user's credit card the amount specified in the invoice immediately.
resend	Resends the invoice to the user by email.

InvoiceComponent

Represents a component of an invoice.

This class is relevant for reseller portals only.

Attributes

product	String	The name of a CTERA Portal product.
unitPrice	Currency	The price of the product per unit. This attribute is optional.
quantity	Integer	The number of units of the product This attribute is optional.
totalPrice	Currency	The total amount owed for the product. This attribute is optional.

IntervalSchedule

Represents a schedule for automatically backing up files every specified interval.

Attributes

hours	Integer	The amount of time between automatic cloud backups, in hours. The value must be greater than 0.
minutes	Integer	The amount of time between automatic cloud backups, in minutes. The value must be greater than 0.

IpRange

Represents an IP address range.

Attributes

start	ipv4	The first IP address in the IP address range.
end	ipv4	The last IP address in the IP address range. This attribute is optional.

Log

Represents a log message. This class is not used directly. It is used only by other classes extending this class.

Attributes

id	Integer	The log's ID number. This attribute is optional.
time	dateTime	The time at which the event occurred.
username	String	The portal administrator or user who triggered the event. This attribute is optional.
source	String	Source of the log file. This attribute is optional.
sourceType	LogSourceType	See LogSourceType. This attribute is optional.

MailSettings

Represents mail settings for a virtual portal.

Attributes

sender

friendlyEmail

The email address that should appear in the From field of notifications sent to end users and staff by the virtual portals.

The default value is:

<![CDATA[CTERA Customer Service <support@ctera.com>]]>

ManagedDevice

This class is currently undocumented. For additional information, contact CTERA support.

MonthlySchedule

Represents a schedule for automatically performing a task every month.

Attributes

day	Integer	The day of the month on which the task should be executed. The value must be between 1 and 31.
hour	Integer	The hour at which the task should be executed. The value must be between 0 and 23.
minute	Integer	The minute at which the task should be executed. The value must be between 0 and 59.

NoPlanDefaults

Represents the default settings to use when there is no plan assigned to the user account, in a reseller portal.

Attributes

retentionPolicy

RetentionPolicy

A RetentionPolicy object.

Notification

Represents an email notification.

Attributes

name	String	The notification's name.
displayName	String	The notification's name as displayed in the notification itself.
disabled	Boolean	Set this attribute to false to enable sending this notification to users. Otherwise, set this attribute to true.
threshold	Integer	The threshold which, if exceeded, triggers sending this notification. This attribute is optional.
period	Integer	The period of the notification.

XML Encoding Example

<val>false</val>

</att>

<val>Addon is about to expire</val>

</att>

<val>AddOnAboutToExpire</val>

</att>

</att>

</obj>

NotificationCategories

Specifies which notification categories should be sent to a specific user.

Attributes

administratorAlerts	Boolean	Set this attribute to true to indicate that the user should receive administrator alerts, as well as a monthly administrator report. Otherwise, set this attribute to false. The default value is true.
customerAlerts	Boolean	Set this attribute to true to indicate that the user should receive customer alerts about device-level problems. Otherwise, set this attribute to false. The default value is false.
customerBillingMessages	Boolean	Set this attribute to true to indicate that the user should receive customer billing messages. Otherwise, set this attribute to false. The default value is false. This attribute is relevant for reseller portals only.
customerReports	Boolean	Set this attribute to true to indicate that the user should receive reports of customer activity. Otherwise, set this attribute to false. The default value is false.
adminReports	Boolean	Set this attribute to true to indicate that the user should receive reports of portal-level activity. Otherwise, set this attribute to false. The default value is true.

OfficeOnlineSettings

Specifies settings when using Microsoft Office Online Server from the CTERA Portal.

Attributes

enabled	Boolean	Set this attribute to true to use Microsoft Office Online Server to create and edit files using lightweight, web browser-based versions of Microsoft Office applications. Otherwise, set this attribute to false. The default value is false.
isBusinessUsers	Boolean	Set this attribute to true to use Office 365 Online, in a public cloud hosted by Microsoft and your enterprise has a Microsoft O365 license for its users. Otherwise, set this attribute to false. The default value is true.
discoveryUrl	String	The URL to enable using Office Online with files stored on the portal. This URL is either the URL for a local server when using Office Online Server on-premise or the URL received from Microsoft when using Office Online as a service from Microsoft.
accessTokenExpirePeriodMinutes	Integer	The amount of time in minutes for a session access token to expire. The default value is 720.

PasswordPolicySettings

This class is currently undocumented. For additional information, contact CTERA support.

PasswordsHistoryParams

This class is currently undocumented. For additional information, contact CTERA support.

Plan

Represents a subscription plan.

This class extends the BaseObject class.

Attributes

name	objNameWithNonAscii	The plan's name. The name is mandatory and can have a maximum of 255 characters.
storage	PlanItem	A PlanItem object representing the amount of storage quota included in the plan. The default value for reseller portals is 10GB. The default value for team portals is unlimited. The default value for global plans is 100GB.
serverAgents	PlanItem	A PlanItem object representing the number of server agents included in the plan. The default value for global plans and reseller portals is 0. The default value for team portals is unlimited.
workstationAgents	PlanItem	A PlanItem object representing the number of workstation agents included in the plan. The default value is 0 workstation agents, where purchase of additional workstation agents is not allowed. The default value for global plans and reseller portals is 0. The default value for team portals is unlimited.
appliances	PlanItem	The maximum number of CTERA Cloud Storage Gateways that a plan member can connect. The default value for reseller portals is 1. The default value for team portals is unlimited. The default value for global plans is 10.
cloudDrives	PlanItem	The maximum number of cloud folders that a plan member can own. The default value for reseller and team portals is 1 if the Cloud Drive service is included in the plan and 0 if the Cloud Drive service is not included in the plan. The default value for global plans is 10.
cloudDrivesLite	PlanItem	The maximum number of Cloud Drive Connect licenses for a plan.
vGateways4	PlanItem	The maximum number of virtual gateway EV4 licenses for a plan.
vGateways8	PlanItem	The maximum number of virtual gateway EV8 licenses for a plan.
vGateways32	PlanItem	The maximum number of virtual gateway EV32 licenses for a plan.
vGateways64	PlanItem	The maximum number of virtual gateway EV64 licenses for a plan.
displayDescription	String	A description of the plan. This attribute is optional.
enabled	Boolean	Set this attribute to true to enable this plan. Otherwise, set this attribute to false. The default value is true.
availableToEndUsers	Boolean	Set this attribute to true to make this plan available to users in the End User Portal. This attribute is relevant for reseller portals only. The default value is true.
planBillingId	String	The plan's billing ID. This attribute is optional.
subscriptionPeriod	Integer	The number of days after the plan has been added to the user account that the plan will expire. This attribute is optional.
isTrial	Boolean	Set this attribute to true to indicate that the plan includes a free trial period. Otherwise set this attribute to false. This attribute is relevant for reseller portals only. The default value is false.
retentionPolicy	RetentionPolicy	A RetentionPolicy object. The default values are inherited from the global plan to which the portal is subscribed.
requireCreditCard	Boolean	Set this attribute to true to require users to pay for this subscription plan automatically via credit card. Otherwise, set this attribute to false. This attribute is relevant for reseller portals only, and appears only if the billing feature is enabled for the portal. The default value is false.
price	Currency	The plan's price in USD per billing cycle. This attribute is relevant for reseller portals only. It is optional.
isDefault	Boolean	Set this attribute to true to make it the default subscription plan. Otherwise, set this attribute to false. The default value is false.
billingCycle	BillingCycle	The plan's billing interval. See BillingCycle. This attribute is relevant for reseller portals only, and appears only if the billing feature is enabled for the portal. The default value is monthly.
sortIndex	Integer	An index number assigned to the subscription plan, in order to enable custom sorting of the subscription plans displayed to end users in the Subscribe to Plan wizard. This attribute is optional. Its minimum value is 1.
services	PortalServiceStatus[]	An array of PortalServiceStatus objects. The default value for global plans is OK for all portal services. The default value for a virtual portal is inherited from the portal's global plan. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

createVouchers	Creates vouchers for the plan.
getPlanDescription	Retrieves a description of the plan.
setAsDefault	Sets the plan as the default plan for all new user accounts.

XML Encoding Example

<val>PlanName</val>

</att>

<val>false</val>

</att>

</att>

<val>Basic 10GB</val>

</att>

</att>

</att>

</att>

</att>

</att>

<val>objs/2//ResellerPortal/ea</val>

</att>

</att>

<val>false</val>

</att>

<val>false</val>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</att>

<val>false</val>

</att>

</att>

<list>

<val>Cloud Backup</val>

</att>

</att>

</obj>

<val>Remote Access</val>

</att>

</att>

</obj>

<val>Logging and Reporting</val>

</att>

</att>

</obj>

<val>Firmware Updates</val>

</att>

</att>

</obj>

<val>Management and Monitoring</val>

</att>

</att>

</obj>

</att>

</att>

</obj>

<val>Cloud folders</val>

</att>

</att>

</obj>

<val>Cloud file sharing</val>

</att>

</att>

</obj>

<val>Seeding</val>

</att>

<val>Disabled</val>

</att>

</obj>

<val>CTERA Agents</val>

</att>

</att>

</obj>

</list>

</att>

<val>false</val>

</att>

</att>

<val>Server Agents</val>

</att>

</obj>

</att>

<val>false</val>

</att>

</att>

<val>Storage Quota</val>

</att>

</obj>

</att>

<val>false</val>

</att>

</att>

<val>Workstation Agents</val>

</att>

</obj>

</att>

<val>monthly</val>

</att>

<val>false</val>

</att>

</att>

<val>Cloud storage gateways</val>

</att>

</obj>

</att>

<val>false</val>

</att>

</att>

<val>Cloud Drives</val>

</att>

</obj>

</att>

</obj>

PlanAutoAssignmentRule

This class is currently undocumented. For additional information, contact CTERA support.

PlanItem

Represents information about an item included in a plan.

Attributes

name	PlanItemEnum	The item's type. See PlanItemEnum.
amount	Integer	The amount of storage space, number of workstation agents, or number of server agents. This attribute is optional.
allowAdditionalPurchase	Boolean	Set this attribute to true to allow users to purchase additional item units beyond the number included in the subscription plan. Otherwise, set this attribute to false. This attribute is relevant for reseller portals only, and appears only if the billing feature is enabled for the portal. The default value is false.
bulkSize	Integer	The bulk amount in which users can buy additional item units. This attribute is relevant for reseller portals only, and appears only if the billing feature is enabled for the portal. This attribute is optional.
additionalPrice	Currency	The price per bulk purchase of additional items in USD. This attribute is relevant for reseller portals only, and appears only if the billing feature is enabled for the portal. This attribute is optional.

XML Encoding Example

See the example for Plan.

PlanOptions

Represents additional items added to a user account's assigned subscription.

Attributes

additionalStorage	Integer	The amount of additional storage space added to the user account's subscription, in GB. The minimum value is 0. This attribute is optional.
additionalServerAgents	Integer	The number of additional server agents added to the user account's subscription. The minimum value is 0. This attribute is optional.
additionalWorkstationAgents	Integer	The number of additional workstation agents added to the user account's subscription. The minimum value is 0. This attribute is optional.
additionalAppliances	Integer	The number of additional cloud storage gateways added to the user account's subscription. The minimum value is 0. This attribute is optional.

XML Encoding Example

See the example for Plan.

PlansStatisticsReport

Represents a Plans Report.

This class extends the Report class.

Attributes

statistics

PlanStatistics[]

An array of PlanStatistics objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

XML Encoding Example

</att>

</att>

<val>plansStatisticsReport</val>

</att>

<val>objs/11//ResellerPortal/vk1</val>

</att>

<list>

</att>

</att>

<val>default</val>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</list>

</att>

</att>

</obj>

PlanStatistics

Represents statistics for a plan in the Plans Report.

Attributes

portal	String	The name of the virtual portal in which this plan is defined.
name	String	The plan's name. This attribute is optional.
liveSubscriptionCount	Integer	The number of subscriptions to the plan that are not expired.
expiredSubscriptionCount	Integer	The number of expired subscriptions to the plan.
additionalStorage	Integer	The amount of additional storage purchased by users who are subscribed to this plan, in GB. For example, if two users are subscribed to this plan, one of whom purchased 5GB of additional storage and the other of whom purchased 2GB of additional storage, set this attribute to 7GB. This attribute is relevant only for plans that allow purchasing additional storage. This attribute is optional.
additionalServerAgents	Integer	The number of additional server agent licenses purchased by users who are subscribed this plan. For example, if two users are subscribed to this plan, one of whom purchased 3 additional server agent licenses and the other of whom purchased 2 additional server agent licenses, set this attribute to 5. This attribute is relevant only for plans that allow purchasing additional server agent licenses. This attribute is optional.
additionalWSAgents	Integer	The number of additional workstation agent licenses purchased by users who are subscribed to this plan. For example, if two users are subscribed to this plan, one of whom purchased 10 additional workstation agent licenses and the other of whom purchased 8 additional workstation agent licenses, set this attribute to 18. This attribute is relevant only for plans that allow purchasing additional workstation agent licenses. This attribute is optional.
additionalAppliances	Integer	The number of additional cloud storage gateway licenses purchased by users who are subscribed to this plan. For example, if two users are subscribed to this plan, one of whom purchased 10 additional cloud storage gateway licenses and the other of whom purchased 8 additional cloud storage gateway licenses, set this attribute to 18. This attribute is relevant only for plans that allow purchasing additional cloud storage gateway licenses. This attribute is optional.
totalStorageQuota	Integer	The total amount of cloud storage space quota included in all instances of this plan, in GB. For example, if 10 users are subscribed to a plan with 10GB storage space, set this attribute to 100GB. This attribute is optional.
totalServerAgents	Integer	The total number of server agent licenses included in all instances of this plan. For example, if 10 users are subscribed to a plan with 5 server agents, set this attribute to 50. This attribute is optional.
totalWSAgents	Integer	The total number of workstation agent licenses included in all instances of this plan. For example, if 10 users are subscribed to a plan with 10 workstation agents, set this attribute to 100. This attribute is optional.
totalAppliances	Integer	The total number of cloud storage gateway licenses included in all instances of this plan. This attribute is optional.
totalCloudDrives	Integer	The total number of cloud drive licenses included in all instances of this plan. This attribute is optional.
totalC200	Integer	The number of C200 cloud storage gateways owned by users who are subscribed to the plan. This attribute is optional.
totalC400	Integer	The number of C400 cloud storage gateways owned by users who are subscribed to the plan. This attribute is optional.
totalC800	Integer	The number of C800 cloud storage gateways owned by users who are subscribed to the plan. This attribute is optional.
totalCloudServerAgent	Integer	The number of server agents in Cloud Agent mode owned by users who are subscribed to the plan. This attribute is optional.
totalCloudWorkstationAgent	Integer	The number of workstation agents in Cloud Agent mode owned by users who are subscribed to the plan. This attribute is optional.
totalHC400	Integer	The number of HC400 cloud storage gateways owned by users who are subscribed to the plan. This attribute is optional.
totalHC1200	Integer	The number of HC1200 cloud storage gateways owned by users who are subscribed to the plan. This attribute is optional.

Portals

Represents a virtual portal. It is not used directly. Use one of the following classes instead:

ResellerPortal

TeamPortal

This class extends the BaseObject class.

Attributes

portalType	PortalObjType	The portal's type. See PortalObjType. The default value is team.
devices	ManagedDevice[]	An array of ManagedDevice objects. This attribute is optional. It should be omitted when creating a new portal.
domains	Domain[]	An array of Domain objects. This attribute is optional. It should be omitted when creating a new portal.
users	PortalUser[]	An array of PortalUser objects. This attribute is optional. It should be omitted when creating a new portal.
plans	Plan[]	An array of Plan objects. This attribute is optional.
localGroups	PortalGroup[]	An array of PortalGroup objects. This attribute is optional.
foldersGroups	FoldersGroup[]	An array of FoldersGroup objects. This attribute is optional. It should be omitted when creating a new portal.
cloudFolders	CloudFolder[]	An array of CloudFolder objects. This attribute is optional.
backups	Backup[]	An array of Backup objects. This attribute is optional.
cloudDrives	CloudDrive[]	An array of CloudDrive objects. This attribute is optional.
projects	PortalProject[]	An array of PortalProject objects. This attribute is optional.
invites	PortalInvitation[]	An array of PortalInvitation objects. This attribute is optional.
deviceTemplates	DeviceTemplate[]	An array of DeviceTemplate objects. This attribute is optional.
skins	Skin[]	An array of Skin objects. This attribute is optional.
templates	CustomizedTemplate[]	An array of CustomizedTemplate objects. This attribute is optional.
deviceTemplatesAutoAssignmentRules	DeviceTemplateAutoAssignmentRule[]	An array of DeviceTemplateAutoAssignmentRule objects. This attribute is optional.
PlanAutoAssignmentRules	PlanAutoAssignmentRule[]	An array of PlanAutoAssignmentRule objects. This attribute is optional.
settings	PortalSettings	A PortalSettings object. This attribute is optional.
cloudDrivePolicyRule	CloudDrivePolicyRule[]	An array of CloudDrivePolicyRule objects. This attribute is optional.
rolesSettings	RolesSettings	A RolesSettings object.
portalStats	PortalStats	A PortalStats object. The default value is 0 for all statistics. This attribute is optional and read-only. It should be omitted when creating a new portal.
alerts	AlertRule[]	An array of AlertRule objects. This attribute is optional.
reports	Report[]	An array of Report objects. This attribute is optional and read-only. It should be omitted when creating a new portal.
logs	Log[]	An array of Log objects. This attribute is optional and read-only. It should be omitted when creating a new portal.
dnsName	String	The DNS name of the CTERA Portal. This attribute is optional.
enableResellerProvisioning	Boolean	Set this attribute to true to enable provisioning a reseller portal. Otherwise, set this attribute to false. The default value is true.
plan	Ref	A link to the global plan assigned to this portal. This attribute is optional.
expirationDate	Date	The expiration date of the global plan assigned to this portal. This attribute is optional.
expired	Boolean	Set this attribute to true to indicate that the global plan assigned to this portal has expired. Otherwise, set this attribute to false. The default value is false.
portalAddOns	UserAddOn[]	An array of UserAddOn objects. This attribute is optional.
sla	EffectiveSLA	An EffectiveSLA object. This attribute is optional.
defaultGroup	Ref	A link to the default folder group of this portal. This attribute is optional. It is relevant for team portals only.
ipBasedAccessControl	IpRange[]	An array of IpRange objects. This attribute is optional.
directoryConnector	DirectoryConnector	A DirectoryConnector object. This attribute is optional.
PortalDisplayInfo	String	The virtual portal owner's billing ID. This attribute is optional.
firstTimeConfiguration	Boolean	This attribute is used to change the portal name on first login. It should not be used by default. This attribute is optional.
useKerberos	Boolean	Set to true to use the Kerberos protocol for authentication when communicating with an Active Directory domain. The default value is false. This attribute is optional.
companyName	String	The name of the company, up to a maximum of 50 characters. This attribute is optional.
catalogNode	Ref	A link to the virtual portal's catalog node server. Catalog node servers are database servers that store metadata. CTERA Portal supports multiple catalog node servers for scalability. The default is to randomly select any catalog node. This attribute is optional.
activationStatus	PortalActivationStatus	The portal's activation status. See PortalActivationStatus. The default value is Enabled.
portalNotifications	PortalNotification[]	An array of PortalNotification objects. This attribute is optional.
projectManagePermissions	ProjectManagementPermissionRule[]	An array of ProjectManagementPermissionRule objects that define the rules for each project in the portal. This attribute is optional.
samlCertificate	SamlCertificate	The SAML certificate. This attribute is optional.
ssoType	SsoType	The single sign-on type. See SsoType. The default value is None.
samlSettings	SamlSettings	A DirectoryConnector object. This attribute is optional.
isDefault	Boolean	Set this attribute to true to indicate that this portal is the default portal the administrator is directed to when logging in. Otherwise, set this attribute to false. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

addAddon	Adds an addon for a portal.
addAttachmentsFolderReturnId	Returns the ID of the attachments folder that was added.
addCloudDrive	Adds a cloud drive to the portal.
addCloudDrivePolicyRule	Adds a cloud policy rule.
addCloudDriveReturnID	Returns the ID of the cloud device that was added.
addGroup	Adds a new end-user group to the portal.
answerCaptcha	Retrieves the user's answer to the captcha.
answerRecoverCaptcha	Answers a user's submission of a password recovery captcha.
applyAutoAssignmentRules	Applies automatic template assignment rules.
attachDevice	Connects a device to the portal.
cancelFileManagerTask	Cancels the FileManager task.
cancelTask	Cancels a task.
changeSystemAdminPassword	Changes the administrator password for the portal.
checkUsername	Validates the username when a user logs into the portal.
checkUsernameAndMail	Checks if a submitted user name and email address already exist in the portal.
copyLink	Copies a public link to a folder or file.
copyResources	Copies the user's resources (files and folders).
createFolderGroup	Creates a new folder group.
createShare	Creates a shared object, which contains the files and folders that were shared with specified people.
customizeTemplate	Customizes a template.
delete	Deletes a portal.
deleteAllFolders	Deletes all the folders in the portal.
deleteCloudDrivePolicyRules	Deletes a cloud policy rule.
deleteFilesFromQuarantine	Deletes files from the quarantine.
deleteResources	Deletes the user's resources (files and folders).
deleteShare	Deletes the shared object, which contains the files and folders that were shared with specified people.
fetchGroups	Retrieves groups from Active Directory.
fetchResources	Fetches the user's resources (files and folders).
generateAdminReport	Generates an Administrator Report for a portal.
generateReport	Generates a report for this portal. See Generating Reports.
getADTrustedDomains	Retrieves all trusted Active Directory domains.
getAllowedDeviceTypes	Retrieves all allowed device types.
getAntivirusGlobalStatus	Retrieves the antivirus status for the entire portal.
getAutoAssignmentRules	Retrieves all automatic template assignment rules.
getdefaultFirmwareUrl	Retrieves the URL of the default firmware.
getDefaultPlan	Retrieves the default plan to which new users are subscribed.
getDeviceAdminUsername	Retrieves the administrator user name of a device.
getDomains	Retrieves all domains.
getEmailFromInvitation	Retrieves the email from the invitation.
getFeatures	Retrieves the set of features supported by the portal.
getFirmwares	Retrieves all firmwares.
getGlobalPlans	Retrieves all global plans.
getNFSFolderSeedingInfo	Retrieves seeding information from an NFS folder.
getPlanAutoAssignmentRules	Retrieves all automatic plan assignment rules.
getPlanDescription	Retries the plan description.
getPortalAddons	Retrieves a list of the portal's addons.
getPortalExtendedStatus	Retrieves the statuses all the portals.
getPortals	Retrieves all portals.
getQuarantineGlobalStatus	Checks the status of the quarantine of the entire portal.
getSeedingStations	Retrieves a list of seeding stations configured for the portal.
getSettings	Retrieves a portal's settings.
getShareDetails	Retrieves the details of a shared object, which contains the files and folders that were shared with specified people.
getStatistics	Retrieves portal statistics.
getTaskStatus	Retrieves a task's status.
getTemplate	Retrieves a template.
getTemplates	Retrieves all email notification templates.
getUpdatedFoldersList	Retrieves a list of the portal's folders.
hideNotifications	Hide the portal notifications.
importNFSFolder	Imports a folder from an NFS server.
importS3Folder	Imports a folder from an S3 storage node.
inviteToRegister	Sends an invitation to register to the portal.
isValidPhoneNumber	Checks whether the specified phone number is valid.
listPublicShares	Lists the resources that the user shared publicly (files and folders).
listShares	Lists the resources that the user shared (files and folders).
listVersions	Lists all versions of an infected item.
makeCollection	Creates a collection of the user's resources (files and folders).
moveResources	Moves the user's resources (files and folders).
notifyChange	Notifies all servers in the system of some change.
queryLogs	Queries the CTERA Portal logs.
registerUser	Registers the specified user to the portal.
removeAddon	Removes an addon from a portal.
removeCloudDrive	Deletes a cloud drive from the portal.
removeDefaultDeviceTemplate	Removes the default device template.
removeDefaultPlan	Removes the default plan to which new users are subscribed.
removeDefaultSkin	Removes the currently applied skin.
rescanFilesFromQuarantine	Rescans the files in the quarantine.
resend	Resends the details of a shared object, which contains the files and folders that were shared with specified people.
resendVerificationCode	Sends the verification code again.
restoreResources	Restores the user's resources (files and folders).
saveAndFetchADUsers	Saves Active Directory connection settings and fetches users from an Active Directory domain.
searchAD	Searches Active Directory.
setAutoAssignmentRules	Modifies automatic template assignment rules.
setPlanAutoAssignmentRules	Modifies automatic plan assignment rules.
setSettings	Modifies a portal's settings.
shareResources	Shares the user's resources (files and folders).
subscribe	Subscribes the portal to a plan.
syncAD	Synchronizes CTERA Portal with Active Directory.
testAndSaveAD	Verifies connection to the specified Active directory domain, and saves the new setting if successful.
unCustomizeTemplate	Resets a template to its default settings, removing all customizations.
unhideNotifications	Unhide the portal notifications.
unsubscribe	Unsubscribes the portal from a plan.
updateAccounts	Updates user accounts.
updateShare	Updates a shared object that contains the files and folders that are shared with specified people.
updateSkinCache	Updates the skin cache of the portal.
validateCurrentLoggedInUserPassword	Validates the username and password of a currently logged-in user.
validateVoucher	Validates the voucher.
verifyVerificationCode	Verifies the verification code that the user used to register to the portal.

PortalAdmin

Represents a CTERA Portal administrator.

This class extends the BaseUser class.

Attributes

role	AdminPortalRole	The administrator's role. See AdminPortalRole. The default value is ReadWriteAdmin.
password	password	The administrator's password. This attribute is optional.
requirePasswordChangeOn	date	The date on which a password change is required. This attribute is optional.

Attributes Inherited from the Parent Class BaseUser

name	objNameWithNonAscii	The administrator's user name.
firstName	String	The administrator's first name.
lastName	String	The administrator's last name.
email	String	The administrator's email address.
userAvatarName	String	The user's avatar name.
company	String	The administrator's company. This attribute is optional.
lastReportSentDate	Date	The date on which a report was last sent to this administrator. This attribute is optional.
notificationCategories	NotificationCategories	A NotificationCategories object.
lastLogin	dateTime	The date on which the administrator last logged in. This attribute is optional.
language	Language	The user's language. See Language. The default value is the value of the Interface Language setting under Default Settings for New Users in the Virtual Portal Settings page of the portal web interface.
passwordsHistory	PasswordsHistoryParams	An array of the user's previous passwords. See PasswordsHistoryParams.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

changePassword	Changes the password of an administrator.
Delete	Deletes an invitation that was sent.
inviteToRegister	Invites a new user to register to the portal.

Extended Methods Inherited from the Parent Class BaseUser

attachDevice	Associates a device with a administrator.
attachMobileDevice	Associates a mobile device with a administrator.
changeEmailRequest	Changes the email address associated with a administrator.
delete	Deletes a administrator.
recoverPassword	Recovers a administrator's password.
recoverPasswordChange	Changes a administrator's password.

PortalEndUser

Represents a CTERA Portal end user.

This class extends the BaseUser class.

Attributes

role	PortalRole	The end user's role. See PortalRole. The default value is EndUser.
groups	ref[]	An array of links to user groups to which the end user belongs. This attribute is optional.
address	BillingAddress	A BillingAddress object. This attribute is optional.
secondaryUsername	String	An additional username or passcode, for cases in which an additional authentication step is required other than the user name and password. This attribute is optional.
billingId	String	The user's billing ID. The attribute is relevant for reseller portals only. It is optional.
externalAccountId	String	The user's ID in an external billing system. This attribute is optional.
plan	Ref	A link to the end user's assigned plan. This attribute is optional.
assignedPlan	Ref	A link to the end user's assigned plan. This attribute is optional.
addOns	UserAddOn[]	An array of UserAddOn objects. This attribute is optional.
userStats	PortalUserStats	A PortalUserStats object.
accountStatus	AccountStatus	The account's status. See AccountStatus. The default value is active.
calculatedAccountStatus	CalculatedAccountStatus	The calculated account status. See CalculatedAccountStatus. The default value is active. This attribute is optional.
creditCard	CreditCard	A CreditCard object. This attribute is relevant for reseller portals only. It is optional.
expirationDate	Date	Expiration date for the user subscription. This attribute is optional. It is only relevant if the user is assigned to a time-limited trial plan.
expired	Boolean	This attribute is set to true if the user plan has expired. This attribute is calculated automatically based on the expirationDate attribute. The default value is false.
userExpirationDate	Date	Expiration date for the user account. This attribute is optional.
userExpired	Boolean	This attribute is set to true if the user account has expired. This attribute is calculated automatically based on the userExpirationDate attribute. The default value is false.
planOptions	PlanOptions	A PlanOptions object. This attribute is optional.
sla	EffectiveSLA	The service level of this user, represented by an EffectiveSLA object. This attribute is optional.
calculatedSla	EffectiveSLA	The service level of this user, represented by an EffectiveSLA object. This is calculated automatically. This attribute is optional.
anniversaryDate	Date	The billing anniversary date. Invoices are sent monthly or annually, starting from this date. This attribute is relevant for reseller portals only. This attribute is optional.
defaultBackupGroup	Ref	A link to the default backup folder group to use for all new devices attached to this user account. This attribute is optional.
defaultCloudDriveGroup	Ref	A link to the default cloud drive folder group to use for all new devices attached to this user account. This attribute is optional.
backupCooperativeDedup	TeamPortalDeduplicationLevel	The level at which deduplication of backups is performed. See TeamPortalDeduplicationLevel. The default value is user.
cloudDriveCooperativeDedup	TeamPortalDeduplicationLevel	The level at which deduplication of cloud drive folders is performed. See TeamPortalDeduplicationLevel. The default value for reseller portals is user. The default value for team portals is portal.
homeFolder	Ref	A link to the home folder in which the cloud drive files should be stored for this user account. This attribute is optional.
uuid	Integer	The user's globally unique ID. This attribute is optional.
generateReportDisabled	Boolean	Set this attribute to true to indicate that the user should receive customer reports. Otherwise, set this attribute to false. This attribute is optional.

Attributes Inherited from the Parent Class BaseUser

name	objNameWithNonAscii	The user's user name.
firstName	String	The user's first name.
lastName	String	The user's last name.
email	String	The user's email address.
userAvatarName	String	The user's avatar name.
company	String	The user's company. This attribute is optional.
lastReportSentDate	Date	The date on which a report was last sent to this user. This attribute is optional.
notificationCategories	NotificationCategories	A NotificationCategories object.
lastLogin	dateTime	The date on which the user last logged in. This attribute is optional.
language	Language	The user's language. See Language. The default value is the value of the Interface Language setting under Default Settings for New Users in the Virtual Portal Settings page of the portal web interface.
passwordsHistory	PasswordsHistoryParams	An array of the user's previous passwords. See PasswordsHistoryParams.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

activateDevice	Activates one of the user's devices.
addAddon	Adds an addon to this user. See Adding an Addon to a Portal User.
addVoucher	Adds a voucher to this user.
answerCaptcha	Returns an answer to a captcha submission.
answerRecoverCaptcha	Returns an answer to a captcha submitted by the user recovering the password.
attachDevice	Attaches a device to the user's account.
changeEmailRequest	Changes the user's email.
delete	Deletes the end user from the portal.
deleteAllFolders	Deletes all folders associated with this user.
generateReport	Generates an end user report for this user. See Generating Reports.
getDevicesDetails	Retrieves information about all devices associated with this user.
getInvitations	Retrieves all invitations sent by the user.
getInvoice	Retrieves this user's latest invoice.
getLastModifiedOfFiles	Retrieves the last modified versions of files.
recoverPassword	Recovers the user's password.
recoverPasswordChange	Returns an answer to a recover password request submitted by the user.
removeAddon	Removes an addon from this user. See Removing an Addon from a Portal User.
searchMembers	Searches users in the database.
subscribe	Sets the user's plan. See Setting the Plan of a Portal User.
unsubscribe	Unsubscribes this user from their current plan.
validatePassword	Validates this user's password.
validateVoucher	Validates a voucher for this user.

Extended Methods Inherited from the Parent Class BaseUser

attachDevice	Associates a device with a user.
attachMobileDevice	Associates a mobile device with a user.
changeEmailRequest	Changes the email address associated with a user.
delete	Deletes a user.
recoverPassword	Recovers a user's password.
recoverPasswordChange	Changes a user's password.

PortalGuiSettings

Represents user interface settings for a virtual portal.

Attributes

language	Language	The user interface language. See Language. The default value is en (English).
aboutUrl	String	The URL to which End User portal users should browse for information about your company. The default value is: http://www.ctera.com/home/about-us.html
cloudStorageGatewayUrl	String	The URL to which End User portal users should browse for Cloud Storage Gateway information. The default value is: http://www.ctera.com/technology/cloud-storage-gateways/
legalUrl	String	The URL to which End User portal users should browse for your company's legal agreement. The default value is: commondir/EULA.html
serviceAgreementUrl	String	The URL to which End User portal users should browse for your company's service agreement. The default value is: commondir/EULA.html
connectHelperUrl	String	The URL to include in the portal device connection helper wizard. The default value is: commondir/connect.html
connectWizWidth	Integer	The width of the device connection helper wizard in pixels. The default value is 600.
connectWizHeight	Integer	The height of the device connection helper wizard in pixels. The default value is 400.
avatarEdgeSize	Integer	The size of the avatar in pixels. The default is 200.
showUserTabToAdminInTeamPortal	Boolean	Set this attribute to true to show the user tab when an administrator is logged into a team portal. Set this attribute to false to hide the user tab when an administrator is logged into a team portal. The default value is false.
hideInstallAgent	Boolean	Set this attribute to true to hide the link for installing CTERA Agent from the virtual portal. The default value is false.
staffHelpUrl	String	The online help URL for staff administrators. This attribute is optional.
adminHelpUrl	String	The online help URL for administrators. This attribute is optional.
endUserHelpUrl	String	The online help URL for end users. This attribute is optional.

PortalGroup

Represents a user group within a portal.

This class extends the Group class.

Attributes

This class does not add any attributes to the parent class.

Attributes Inherited from the Parent Class Group

name	objNameWithSpaces	The name of the group. The minimum value is 1.
description	String	A description of the group. This attribute is optional.
membersCount	Integer	The value for this field is NULL. The number of users in the group is calculated using the getMembersCount method.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods Inherited from the Parent Class Group

delete	Deletes the group.
getMembers	Retrieves the list of group members.
searchMembers	Searches for the specified members within the group.
updateGroup	Updates the group with members that were added to the group and deletes members that were removed from the group.

PortalInvitation

Represents an email invitation to access shared files or folders.

This class extends the BaseObject class.

Attributes

key	String	The secret key for accessing the invitation.
expiresOn	Date	The date on which the email invitation expires. This attribute is optional.
path	String	The path to the shared file/folder on the cloud drive.
mode	FileAccessMode	The type of access granted to the invitation recipient. See FileAccessMode.
folder	Ref	A link to the shared file/folder on the cloud drive.
isDirectory	Boolean	Set this attribute to true to indicate that the shared item is a folder. Otherwise, set this attribute to false.
webdavPath	String	A webDAV path to the shared file/folder. This attribute is optional.
createdOn	Date	This attribute is optional.
sendTo	PortalInvitationEmailAndKey[]	An array of PortalInvitationEmailAndKey objects. This attribute is optional.
protectionLevel	ProtectionLevel	The methods applied to protect the invitation from being accessed by unintended recipients. See ProtectionLevel.
trustSecurityCodes	TrustSecurityCode[]	An array of TrustSecurityCode objects. This attribute is optional.
cteraPhoneNumber	CteraPhoneNumber	An array of CteraPhoneNumber objects. This attribute is optional.
customMessage	String	The custom message included in the invitation. This attribute is optional.
publicLink	String	A public link to the shared files. This attribute is optional.
isRestrictedToReadOnly	Boolean	Set this attribute to true to indicate that the invitation can be readOnly and cannot be changed to read/write. Otherwise, set this attribute to false. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.
owner	Ref	A link to the user account that created the invitation. This attribute is optional.

Extended Methods

deleteInvitation	Deletes an email invitation.
getInvitationNotification	Retrieves all active email invitations.
resendInvitation	Resends an email invitation.

PortalInvitationEmailAndKey

Represents the email address to which an email invitation to access shared files or folders is sent, and if applicable, the access code sent within the invitation.

Attributes

email	Email	The email address of the invitation recipient.
partialKey	String	The one time use access code sent to the invitation recipient. This attribute is optional.

PortalInvitationSettings

Represents settings for email invitations.

Attributes

inviteLifetime	Integer	The number of days an invitation is valid. The minimum value is 1. The default value is 30. This attribute is optional.
invitationMaxValidityDuration	Integer	The maximum number of days an invitation is valid. The minimum value is 1. This attribute is optional.
shareMaxValidityDuration	Integer	The maximum number of days an invitation is to a shared folder is valid. The minimum value is 1. This attribute is optional.
protectionLevels	ProtectionLevel[]	An array of protection levels. See ProtectionLevel. The default is email and publicLink. This attribute is optional.
defaultProtectionLevels	ProtectionLevel	The default protection level. See ProtectionLevel. The default value is publicLink. This attribute is optional.
allowCollaboratorsToReshareContent	Boolean	Set the value of this attribute to true to allow collaborators to reshare content. Set the value of this attribute to false to prevent collaborators from resharing content. This default value is true.
allowedFrequentContactsTime	Integer	The default value is 120.

XML Encoding Example

</att>

<val>enabled</val>

</att>

<val>false</val>

</att>

<val>false</val>

</att>

</obj>

</att>

PortalNotification

This class is currently undocumented. For additional information, contact CTERA support.

PortalRoleSettings

Represents the settings of a portal role.

Attributes

name	PortalRole	The name of the role. See PortalRole.
superUser	Boolean	Set to true to give users with this role all permissions. The default value is false.
canAccessEndUserFolders	Boolean	Set to true to allow users with this role access to end users' folders.
canManageAllFolders	Boolean	Set to true to allow users with this role to manage all folders in the portal. This attribute is optional.
canManageUsers	Boolean	Set to true to allow users with this role to manage users in the portal. The default value is true.
canChangeUserEmail	Boolean	Set to true to allow users with this role to change email addresses in user accounts.
canChangeUserPassword	Boolean	Set to true to allow users with this role to change users' passwords.
canManagePlans	Boolean	Set to true to allow users with this role to manage plans in the portal. The default value is true.
canChangePortalSettings	Boolean	Set to true to allow users with this role to change the settings of virtual portals.
canChangeRoles	Boolean	Set to true to allow users with this role to change users' roles.
allowSSO	Boolean	Set to true to allow users with this role to perform Single Sign On on behalf of users. The default value is false.
allowRemoteWipe	Boolean	Set to true to allow users with this role to perform remote wipe of CTERA Mobile devices. The default value is false.
allowSeedingImport	Boolean	Set to true to allow administrators with this role to perform seeding import.
allowSeedingExport	Boolean	Set to true to allow administrators with this role to perform seeding export.

PortalServiceStatus

Represents the status of a service included in a subscription plan or addon.

Attributes

serviceName	String	The service's name.
serviceState	PortalServiceState	The service's current state. See PortalServiceState.
expirationDate	Date	The service's expiration date. This attribute is optional.
moreInfo	String	Additional information about the service. This attribute is optional.

PortalSettings

Represents the settings for a virtual portal.

Attributes

antivirusFileExceptionRules	BackupSet[]	An array of BackupSet objects that specifies antivirus file exception rules. This attribute is optional.
passwordPolicySettings	PasswordPolicySettings	A PasswordPolicySettings object.
mailSettings	MailSettings	A MailSettings object.
mobileAndroidLink	String	The URL to download the CTERA Mobile app for Android devices. This attribute is optional. The default value is https://play.google.com/store/apps/details?id=com.ctera.networks.android.
mobileIOSLink	String	The URL to download the CTERA Mobile app for Apple devices. This attribute is optional. The default value is https://itunes.apple.com/us/app/ctera/id1071368834.
mobileWindowsPhoneLink	String	The URL to download the CTERA Mobile app for Windows mobile devices. This attribute is optional. The default value is https://www.microsoft.com/en-us/store/apps/ctera-mobile/9nblgggz54jn.
allowSelfRegistration	Boolean	Set this attribute to true to allow end users to sign up for a CTERA Portal account, by surfing to the CTERA Portal and filling in a form. Otherwise, set this attribute to false. The default value is false.
voucherSupport	Boolean	Set this attribute to true to enable the use of vouchers in the CTERA Portal. Otherwise, set this attribute to false. The default value is true.
requireVoucher	Boolean	Set this attribute to true to require end users to supply a valid voucher code when registering a new CTERA Portal account. Otherwise, set this attribute to false. The default value is false.
autoDeleteZeroQuotaFiles	Boolean	Set this attribute to true to automatically delete the storage folders of customers who have no quota, for example, customers with expired trial accounts, after the period of time specified by the zeroQuotaGracePeriod attribute. Otherwise, set this attribute to false. The default value is true.
useHttpsForRemoteAccess	Boolean	Set this attribute to true to use HTTPS for remotely accessing the CTERA Portal. Otherwise, set this attribute to false. The default value is false.
zeroQuotaGracePeriod	Integer	The number of days after which the storage folders of customers who have no quota, for example, customers with expired trial accounts, should be deleted automatically. The default value is 14. This attribute is optional.
defaultCloudFSVersion	Integer	The default cloud storage encoding scheme used for new folder groups. The default value is 1. This attribute is optional.
amountOfTimesUserCanChangePasswordInDay	Integer	Maximum amount of times that the user can change the password in a day. The default value is 2. This attribute is optional.
requireChangingPasswordPeriod	Integer	The period after which to require users to change their password. This attribute is optional.
gui	PortalGuiSettings	A PortalGuiSettings object.
allowedDeviceTypes	DeviceType[]	An array of DeviceType objects. This attribute is optional.
requireEmailConfirmation	Boolean	Set this attribute to true to require end users to confirm their registration by email, in order for their CTERA Portal account to be activated. Otherwise, set this attribute to false. The default value is true.
noPlan	NoPlanDefaults	A NoPlanDefaults object.
remoteAccessRedirect	RemoteAccessType	Indicates whether Web clients attempting to remotely access a device should be redirected to communicate directly with the device, instead of relaying communications through the CTERA Portal. See RemoteAccessType. The default value is Private_IP_redirect.
averageBlockSizeKb	Integer	The default average block size used by new folder groups, in Kb. This value must be between 16 and 4096. The default value is 512.
averageMapFileSizeKb	Integer	The default average map file size used by new folder groups, in Kb. The default value is 640000.
averageBlockSizeKbForCloudFS2	Integer	The default average block size used by new folder groups that use CloudFS2, in Kb. This value must be between 4 and 4096. The default value is 512.
averageMapFileSizeKbForCloudFS2	Integer	The default average map file size used by new folder groups that use CloudFS2, in Kb. The default value is 640000.
shouldCompress	Boolean	Set this attribute to true to require devices to compress all blocks that they upload to the portal. Otherwise, set this attribute to false. The default value is true.
compressionMethod	CompressionMethod	The compression method that devices should use for blocks uploaded to the portal. See CompressionMethod. The default value is HighSpeed.
shouldEncrypt	Boolean	Set this attribute to true to store data in this folder group in encrypted format. Otherwise, set this attribute to false. The default value is true.
minimumMapFileBlocks	Integer	The default value is 1.
supportEmail	friendlyEmail	The email address to which support requests should be sent. This email address will appear in the From field of all email notifications sent by the CTERA Portal system. The default value is support@ctera.com.
supportUrl	String	The URL to which CTERA Portal users should browse for customer support. The default value is http://www.ctera.com/support.
requireCompany	Boolean	Set this attribute to true to require end users to specify their company, when registering a new CTERA Portal account. Otherwise, set this attribute to false. The default value is false.
invitationSettings	PortalInvitationSettings	A PortalInvitationSettings object.
teamPortalSpecificSettings	TeamPortalSpecificSettings	A TeamPortalSpecificSettings object.
resellerPortalSpecificSettings	ResellerPortalSpecificSettings	A ResellerPortalSpecificSettings object.
watermarkSettings	WatermarkSettings	A WatermarkSettings object.
footnoteSettings	WatermarkSettings	A customized footnote as part of the WatermarkSettings object. The text to be displayed at the bottom of each page of a file restricted to previewing only. The default is ${date} ${recipient} Not For Distribution. The default footnote text color is #FF0000. The default level of opacity of the footnote text is 50. The less the opacity the fainter the footnote text. The fontSize of the text to use for the footnote. The default is 8. This attribute is enabled by default.
homeFolderSettings	HomeFolderSettings	A HomeFolderSettings object.
cloudProDirectoryEnabled	Boolean	Set this attribute to true to enable connection to a CloudPro directory service. The default value is false.
simplifiedConnectMode	Boolean	Set to true to enable Simplified Connect mode, in which cloud storage gateways can connect to the portal in parking mode, without being fully activated, and the user can activate such cloud storage gateways from the end user portal. The default value is false.
deviceAdminUsernamePolicy	AdminUsernamePolicy	The policy for naming the initial device administrator user. The device's first admin after activating it in simple activation process mode. See AdminUsernamePolicy. The default value is admin.
enableSecondaryUsernameAuthentication	Boolean	Set to true to enable an option for users to authenticate with an additional passcode as well as the username and password. The default value is false.
enableBackupExtendedAttributes	Boolean	Set to true to enable backing up special file permissions and metadata. The default value is true.
enableTemplatesCLI	Boolean	Set to true to enable commands to be defined in a template that devices will run when the template is downloaded. The default value is false.
webDAVHidePreviousVersions	Boolean	Set to true to hide previous versions of files and folders when accessed using webDAV. The default value is false.
encoding	String	The encoding of the zip file that is generated when downloading a directory or multiple files. The default value is UTF-8.
disableLicenseMechanism	Boolean	Set to true to disable the licensing mechanism. The default value is false.
countryCodeForRegion	CountryCodeForRegion	See CountryCodeForRegion. The default value is US.
backupPassphraseProtectionPolicy	BackupPassphraseProtectionPolic	The protection policy for the backup passphrase. See BackupPassphraseProtectionPolicy. The default value is Optional.
cloudDriveLogging	CloudDriveLogging	Permissions for the cloud drive that is used for logging. See CloudDriveLogging. The default value is None.
invitationToRegisterSavePeriod	Integer	The amount of time, in days, for which the invitation is valid. The default value is 7.
attachDeviceRequestSavePeriodMin	Integer	Time period for an SSO login request for a device in minutes. The default value is 10.
cttpKeepAliveInterval	Integer	Interval in seconds in which a keepalive is sent to prevent proxy or load balancer servers from terminating the connection between a CTERA Agent and the CTERA portal. The minimum value is 1. This attribute is optional.
backupDelayInterval	Integer	The minimum interval, in minutes, between successive backups. The minimum value is 1. The default value is 120. This attribute is optional.
cloudSyncDelayInterval	Integer	The minimum interval, in seconds, between successive synchronization actions. The minimum value is 1. The default value is 60. This attribute is optional.
cloudSyncOperationQueueSize	Integer	The queue size when syncing. The minimum value is 1. The default value is 20.
logoutRedirectUrl	String	URL to which users are directed when they log out of the portal. This attribute is optional.
activeDirectorySettings	ActiveDirectorySettings	Configuration settings for connecting the CTERA Portal to an Active Directory. See ActiveDirectorySettings.
officeOnlineSettings	OfficeOnlineSettings	Configuration settings for using Microsoft Office Online from the CTERA Portal. See OfficeOnlineSettings.
showCloudFilesGraph	Boolean	The graph of the files with the amount of modified files. Setting to true is not recommended for large environments. The default value is false.
defaultMail	email	The default email address for notifications. This attribute is optional.
fetchADNestedGroups	Boolean	Whether all groups a user is a member of, including nested groups, can be fetched. Set this attribute to true to fetch nested groups. Otherwise, set this attribute to false. The default value is false.

PortalStatistics

Represents statistics for a virtual portal in the Portals Report.

Attributes

portalName	String	The name of the virtual portal.
PortalDisplayInfo	String	The virtual portal owner's billing ID. This attribute is optional.
cloudDrive	Boolean	Set this attribute to true to include the Cloud Drive service. Otherwise, set this attribute to false.
cloudBackup	Boolean	Set this attribute to true to include the Cloud Backup service. Otherwise, set this attribute to false.
calculatedQuota	Integer	The storage quota allocated to this virtual portal by the global administrator in MB. To indicate that the quota is unlimited, do not assign this attribute a value. This attribute is optional.
allocatedQuota	Integer	For a reseller portal, the sum of all storage quotas allocated to users in the portal in MB. For a team portal, the sum of all storage quotas currently being used by users in the portal in MB.
physicalStorage	Integer	The amount of physical storage used by this virtual portal in MB.
currentSnapshotSize	Integer	The size of the current snapshot of this virtual portal in MB. This attribute is optional.
allSnapshotsSize	Integer	The size of all snapshots of this virtual portal in MB. This attribute is optional.
inUploadSize	Integer	The size of files that are currently being uploaded to this virtual portal in MB. This attribute is optional.
currentSnapshotFiles	Integer	The number of files in the current snapshot, not including previous versions that are stored for this virtual portal. This attribute is optional.
allSnapshotsFiles	Integer	The total number of files in all snapshots, including previous versions that are stored for this virtual portal. This attribute is optional.
inUploadFiles	Integer	The number of files that are currently being uploaded to this virtual portal. This attribute is optional.
badFiles	Integer	The number of corrupted files in the virtual portal. This attribute is optional.
snapshotCount	Integer	The number of previous versions currently stored for this virtual portal.
calculatedServerAgents	Integer	The quota of server agents allocated to this virtual portal by the global administrator. To indicate that the quota is unlimited, do not assign this attribute a value. This attribute is optional.
allocatedServerAgents	Integer	For a reseller portal, this field displays the sum of all server agent quotas allocated to users in the portal. For a team portal, this field displays the sum of all server agent quotas currently being used by users in the portal.
usedServerAgents	Integer	The number of server agent licenses used in this virtual portal.
calculatedWSAgents	Integer	The quota of workstation backups allocated to this virtual portal by the global administrator. To indicate that the quota is unlimited, do not assign this attribute a value. This attribute is optional.
allocatedWSAgents	Integer	For a reseller portal, this field displays the sum of all workstation backup quotas allocated to users in the portal. For a team portal, this field displays the sum of all workstation backup quotas currently being used by users in the portal.
usedWSAgents	Integer	The number of workstation agent licenses used in this virtual portal.
calculatedAppliances	Integer	The quota of cloud storage gateways allocated to this virtual portal by the global administrator. To indicate that the quota is unlimited, do not assign this attribute a value. This attribute is optional.
allocatedAppliances	Integer	For a reseller portal, this field displays the sum of all appliance quotas allocated to users in the portal. For a team portal, this field displays the sum of all appliance quotas currently being used by users in the portal.
usedAppliances	Integer	The number of cloud storage gateway licenses used in this virtual portal.
calculatedCloudDrives	Integer	The quota of cloud drives allocated to this virtual portal by the global administrator. To indicate that the quota is unlimited, do not assign this attribute a value. This attribute is optional.
allocatedCloudDrives	Integer	For a reseller portal, this field displays the sum of all cloud drive quotas allocated to users in the portal. For a team portal, this field displays the sum of all cloud drive quotas currently being used by users in the portal.
usedCloudDrives	Integer	The number of cloud drive licenses used in this virtual portal.
connectedDevices	Integer	The number of devices that are currently connected to the virtual portal.
totalUsers	Integer	The total number of users defined in the virtual portal.

PortalsStatisticsReport

Represents a Portals Report.

This class extends the Report class.

Attributes

statistics

PortalStatistics[]

An array of PortalStatistics objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

XML Encoding Example

</att>

</att>

<val>portalsStatisticsReport</val>

</att>

<list>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

<val>false</val>

</att>

</att>

<val>portal</val>

</att>

</att>

</att>

</att>

</att>

</obj>

</list>

</att>

</att>

</obj>

PortalStats

Represents statistics for a virtual portal.

Attributes

allocatedQuota	Integer	The total storage quota allocated to end user accounts in the virtual portal. The default value is 0.
allocatedAppliances	Integer	The total number of CTERA Cloud Storage Gateways defined in the virtual portal. The default value is 0.
allocatedVGateways4	Integer	The total number of CTERA Cloud Storage Virtual Gateways with EV4 licenses defined in the virtual portal. The default value is 0.
allocatedVGateways8	Integer	The total number of CTERA Cloud Storage Virtual Gateways with EV8 licenses defined in the virtual portal. The default value is 0.
allocatedVGateways32	Integer	The total number of CTERA Cloud Storage Virtual Gateways with EV32 licenses defined in the virtual portal. The default value is 0.
allocatedVGateways64	Integer	The total number of CTERA Cloud Storage Virtual Gateways with EV64 licenses defined in the virtual portal. The default value is 0.
allocatedServerAgents	Integer	The total number of CTERA Server Agent quotas allocated to end user accounts in the virtual portal. The default value is 0.
allocatedWsAgents	Integer	The total number of CTERA Workstation Agent quotas allocated to end user accounts in the virtual portal. The default value is 0.
allocatedCloudDrives	Integer	The total number of CTERA Cloud Drive quotas allocated to end user accounts in the virtual portal. The default value is 0.
allocatedCloudDrivesLite	Integer	The total number of CTERA Cloud Drive Connect quotas allocated to end user accounts in the virtual portal. The default value is 0.
actualQuota	Integer	The total storage quota used in the virtual portal. This attribute is optional.
actualAppliances	Integer	The total CTERA Cloud Storage Gateway quota used in the virtual portal. The default value is 0.
actualVGateways4	Integer	The total CTERA Cloud Storage Virtual Gateways with EV4 licenses used in the virtual portal. The default value is 0.
actualVGateways8	Integer	The total CTERA Cloud Storage Virtual Gateways with EV8 licenses used in the virtual portal. The default value is 0.
actualVGateways32	Integer	The total CTERA Cloud Storage Virtual Gateways with EV32 licenses used in the virtual portal. The default value is 0.
actualVGateways64	Integer	The total CTERA Cloud Storage Virtual Gateways with EV64 licenses used in the virtual portal. The default value is 0.
actualServerAgents	Integer	The total CTERA Server Agents quota used in the virtual portal. The default value is 0.
actualWsAgents	Integer	The total CTERA Workstation Agent quota used in the virtual portal. The default value is 0.
actualCloudDrives	Integer	The total cloud drive quota used in the virtual portal. The default value is 0.
actualCloudDrives	Integer	The total Cloud Drive Connect quota used in the virtual portal. The default value is 0.

XML Encoding Example

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

PortalUser

Represents a CTERA Portal user.

This class extends the PortalEndUser class.

Attributes

password	Password	The user's password.
requirePasswordChangeOn	Date	The date on which the user is required to change the user's password. This attribute is optional.

Attributes Inherited from the Parent Class PortalEndUser

role	PortalRole	The end user's role. See PortalRole. The default value is EndUser.
groups	ref[]	An array of links to user groups to which the end user belongs. This attribute is optional.
address	BillingAddress	A BillingAddress object. This attribute is optional.
secondaryUsername	String	An additional username or passcode, for cases in which an additional authentication step is required other than the user name and password. This attribute is optional.
billingId	String	The user's billing ID. The attribute is relevant for reseller portals only. It is optional.
externalAccountId	String	The user's ID in an external billing system. This attribute is optional.
plan	Ref	A link to the end user's assigned plan. This attribute is optional.
assignedPlan	Ref	A link to the end user's assigned plan. This attribute is optional and is inherited from the plan attribute.
addOns	UserAddOn[]	An array of UserAddOn objects. This attribute is optional.
userStats	PortalUserStats	A PortalUserStats object.
accountStatus	AccountStatus	The account's status. See AccountStatus. The default value is active.
calculatedAccountStatus	CalculatedAccountStatus	The calculated account status. See CalculatedAccountStatus. The default value is active. This attribute is optional.
creditCard	CreditCard	A CreditCard object. This attribute is relevant for reseller portals only. It is optional.
expirationDate	Date	Expiration date for the user subscription. This attribute is optional. It is only relevant if the user is assigned to a time-limited trial plan.
expired	Boolean	This attribute is set to true if the user plan has expired. This attribute is calculated automatically based on the expirationDate attribute. The default value is false.
userExpirationDate	Date	Expiration date for the user account. This attribute is optional.
userExpired	Boolean	This attribute is set to true if the user account has expired. This attribute is calculated automatically based on the userExpirationDate attribute. The default value is false.
planOptions	PlanOptions	A PlanOptions object. This attribute is optional.
sla	EffectiveSLA	The service level of this user, represented by an EffectiveSLA object. This attribute is optional.
calculatedSla	EffectiveSLA	The service level of this user, represented by an EffectiveSLA object. This is calculated automatically. This attribute is optional.
anniversaryDate	Date	The billing anniversary date. Invoices are sent monthly or annually, starting from this date. This attribute is relevant for reseller portals only. This attribute is optional.
defaultBackupGroup	Ref	A link to the default backup folder group to use for all new devices attached to this user account. This attribute is optional.
defaultCloudDriveGroup	Ref	A link to the default cloud drive folder group to use for all new devices attached to this user account. This attribute is optional.
backupCooperativeDedup	TeamPortalDeduplicationLevel	The level at which deduplication of backups is performed. See TeamPortalDeduplicationLevel. The default value is user.
cloudDriveCooperativeDedup	TeamPortalDeduplicationLevel	The level at which deduplication of cloud drive folders is performed. See TeamPortalDeduplicationLevel. The default value for reseller portals is user. The default value for team portals is portal.
homeFolder	Ref	A link to the home folder in which the cloud drive files should be stored for this user account. This attribute is optional.
uuid	Integer	The user's globally unique ID. This attribute is optional.
generateReportDisabled	Boolean	Set this attribute to true to indicate that the user should receive customer reports. Otherwise, set this attribute to false. This attribute is optional.

Attributes Inherited from the Parent Class BaseUser

name	objNameWithNonAscii	The user's user name.
firstName	String	The user's first name.
lastName	String	The user's last name.
email	String	The user's email address.
userAvatarName	String	The user's avatar name.
company	String	The user's company. This attribute is optional.
lastReportSentDate	Date	The date on which a report was last sent to this user. This attribute is optional.
notificationCategories	NotificationCategories	A NotificationCategories object.
lastLogin	dateTime	The date on which the user last logged in. This attribute is optional.
language	Language	The user's language. See Language. The default value is the value of the Interface Language setting under Default Settings for New Users in the Virtual Portal Settings page of the portal web interface.
passwordsHistory	PasswordsHistoryParams	An array of the user's previous passwords. See PasswordsHistoryParams.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

changePassword

Changes the password of a user.

Extended Methods Inherited from the Parent Class PortalEndUser

activateDevice	Activates one of the user's devices.
addAddon	Adds an addon to this user. See Adding an Addon to a Portal User.
addVoucher	Adds a voucher to this user.
answerCaptcha	Returns an answer to a captcha submission.
answerRecoverCaptcha	Returns an answer to a captcha submitted by the user recovering the password.
attachDevice	Attaches a device to the user's account.
changeEmailRequest	Changes the user's email.
delete	Deletes the end user from the portal.
deleteAllFolders	Deletes all folders associated with this user.
generateReport	Generates an end user report for this user. See Generating Reports.
getDevicesDetails	Retrieves information about all devices associated with this user.
getInvitations	Retrieves all invitations sent by the user.
getInvoice	Retrieves this user's latest invoice.
getLastModifiedOfFiles	Retrieves the last modified versions of files.
recoverPassword	Recovers the user's password.
recoverPasswordChange	Returns an answer to a recover password request submitted by the user.
removeAddon	Removes an addon from this user. See Removing an Addon from a Portal User.
searchMembers	Searches users in the database.
subscribe	Sets the user's plan. See Setting the Plan of a Portal User.
unsubscribe	Unsubscribes this user from their current plan.
validatePassword	Validates this user's password.
validateVoucher	Validates a voucher for this user.

Extended Methods Inherited from the Parent Class BaseUser

attachDevice	Associates a device with a user.
attachMobileDevice	Associates a mobile device with a user.
changeEmailRequest	Changes the email address associated with a user.
delete	Deletes a user.
recoverPassword	Recovers a user's password.
recoverPasswordChange	Changes a user's password.

XML Encoding Example

<val>active</val>

</att>

<val>jsmith@acme.com</val>

</att>

</att>

<val>Smith</val>

</att>

<val>jsmith</val>

</att>

<val>johnpassword123</val>

</att>

<val>false</val>

</att>

</att>

<val>portal</val>

</att>

<val>English</val>

</att>

</att>

<val>false</val>

</att>

<val>false</val>

</att>

<val>false</val>

</att>

</obj>

</att>

<val>EndUser</val>

</att>

</obj>

PortalUserStats

Represents statistics for a CTERA Portal user account.

Attributes

foldersSize	Integer	The percentage of storage the user has consumed out of the total amount available in their subscription plan. This attribute is optional.
numAppliances	Integer	The number of devices associated with the user account. This attribute is optional.
numVGateways4	Integer	The number of virtual gateways with an EV4 licenses installed for this user account. This attribute is optional.
numVGateways8	Integer	The number of virtual gateways with an EV8 licenses installed for this user account. This attribute is optional.
numVGateways32	Integer	The number of virtual gateways with an EV32 licenses installed for this user account. This attribute is optional.
numVGateways64	Integer	The number of virtual gateways with an EV64 licenses installed for this user account. This attribute is optional.
numServerAgents	Integer	The number of server agents installed for this user account. This attribute is optional.
numWsAgents	Integer	The number of workstation agents installed for this user account. This attribute is optional.

ProjectACLRule

Represents an access control list (ACL) rule for a project.

Attributes

uid	Integer	A unique ID for the ACL rule.
name	String	The name of the ACL rule.
type	ACLRuleType	The type of user or group given permission. See ACLRuleType.
permissions	ProjectAccessMode	The type of access to the project. See ProjectAccessMode.
expiration	Date	The date on which the rule expires. This attribute is optional.
domain	String	The Active Directory domain name. This attribute is optional.
dn	String	The user or user group's DN. This attribute is optional.

ProjectManagementPermissionRule

This class is currently undocumented. For additional information, contact CTERA support.

Report

Represents a report.

This class is not used directly; instead, use the classes that extend this class:

AddonsStatisticsReport

DevicesStatisticsReport

FolderGroupsStatisticsReport

FoldersStatisticsReport

PlansStatisticsReport

PortalsStatisticsReport

StorageLocationsStatisticsReport

This class extends the BaseObject class.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

ResellerPortal

Represents a reseller portal.

This class extends the Portals class.

Attributes

administrators	PortalAdmin[]	An array of PortalAdmin objects. This attribute is optional.
addOns	AddOn[]	An array of AddOn objects. This attribute is optional.
vouchers	Voucher[]	An array of Voucher objects. This attribute is optional.
invoices	Invoice[]	An array of Invoice objects. This attribute is optional.
notifications	Notification[]	An array of Notification objects. The default value is that all notifications are enabled except the Backup Completed Successfully and User Report notifications, which are disabled.

Attributes Inherited from the Parent Class Portal

portalType	PortalObjType	The portal's type. See PortalObjType. The default value is reseller.
devices	ManagedDevice[]	An array of ManagedDevice objects. This attribute is optional. It should be omitted when creating a new portal.
domains	Domain[]	An array of Domain objects. This attribute is optional. It should be omitted when creating a new portal.
users	PortalUser[]	An array of PortalUser objects. This attribute is optional. It should be omitted when creating a new portal.
plans	Plan[]	An array of Plan objects. This attribute is optional.
localGroups	PortalGroup[]	An array of PortalGroup objects. This attribute is optional.
foldersGroups	FoldersGroup[]	An array of FoldersGroup objects. This attribute is optional. It should be omitted when creating a new portal.
backups	Backup[]	An array of Backup objects. This attribute is optional.
cloudDrives	CloudDrive[]	An array of CloudDrive objects. This attribute is optional.
projects	PortalProject[]	An array of PortalProject objects. This attribute is optional.
invites	PortalInvitation[]	An array of PortalInvitation objects. This attribute is optional.
deviceTemplates	DeviceTemplate[]	An array of DeviceTemplate objects. This attribute is optional.
skins	Skin[]	An array of Skin objects. This attribute is optional.
templates	CustomizedTemplate[]	An array of CustomizedTemplate objects. This attribute is optional.
deviceTemplatesAutoAssignmentRules	DeviceTemplateAutoAssignmentRule[]	An array of DeviceTemplateAutoAssignmentRule objects. This attribute is optional.
PlanAutoAssignmentRules	PlanAutoAssignmentRule[]	An array of PlanAutoAssignmentRule objects. This attribute is optional.
settings	PortalSettings	A PortalSettings object. This attribute is optional.
cloudDrivePolicyRule	CloudDrivePolicyRule[]	An array of CloudDrivePolicyRule objects. This attribute is optional.
rolesSettings	RolesSettings	A RolesSettings object.
portalStats	PortalStats	A PortalStats object. The default value is 0 for all statistics. This attribute is optional and read-only. It should be omitted when creating a new portal.
alerts	AlertRule[]	An array of AlertRule objects. This attribute is optional.
reports	Report[]	An array of Report objects. This attribute is optional and read-only. It should be omitted when creating a new portal.
logs	Log[]	An array of Log objects. This attribute is optional and read-only. It should be omitted when creating a new portal.
dnsName	String	The DNS name of the CTERA Portal. This attribute is optional.
enableResellerProvisioning	Boolean	Set this attribute to true to enable provisioning a reseller portal. Otherwise, set this attribute to false. The default value is true.
plan	Ref	A link to the global plan assigned to this portal. This attribute is optional.
expirationDate	Date	The expiration date of the global plan assigned to this portal. This attribute is optional.
expired	Boolean	Set this attribute to true to indicate that the global plan assigned to this portal has expired. Otherwise, set this attribute to false. The default value is false.
portalAddOns	UserAddOn[]	An array of UserAddOn objects. This attribute is optional.
sla	EffectiveSLA	An EffectiveSLA object. This attribute is optional.
defaultGroup	Ref	A link to the default folder group of this portal. This attribute is optional. It is relevant for team portals only.
ipBasedAccessControl	IpRange[]	An array of IpRange objects. This attribute is optional.
directoryConnector	DirectoryConnector	A DirectoryConnector object. This attribute is optional.
PortalDisplayInfo	String	The virtual portal owner's billing ID. This attribute is optional.
firstTimeConfiguration	Boolean	This attribute is used to change the portal name on first login. It should not be used by default. This attribute is optional.
useKerberos	Boolean	Set to true to use the Kerberos protocol for authentication when communicating with an Active Directory domain. The default value is false. This attribute is optional.
catalogNode	Ref	A link to the virtual portal's catalog node server. Catalog node servers are database servers that store metadata. CTERA Portal supports multiple catalog node servers for scalability. The default is to randomly select any catalog node. This attribute is optional.
activationStatus	PortalActivationStatus	The portal's activation status. See PortalActivationStatus. The default value is Enabled.
portalNotifications	PortalNotification[]	An array of PortalNotification objects. This attribute is optional.
projectManagePermissions	ProjectManagementPermissionRule[]	An array of ProjectManagementPermissionRule objects that define the permissions for each project in the portal. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

addAddons	Adds addons to a user account.
answerCaptcha	Returns an answer to a captcha submission.
checkUsername	Checks if a submitted user name already exists in the portal.
getVouchersNotification	Retrieves a notifications of vouchers.
registerUser	Registers a new user.

Extended Methods Inherited from the Parent Class Portal

addAddon	Adds an addon for a portal.
addAttachmentsFolderReturnId	Returns the ID of the attachments folder that was added.
addCloudDrive	Adds a cloud drive to the portal.
addCloudDrivePolicyRule	Adds a cloud policy rule.
addCloudDriveReturnID	Returns the ID of the cloud device that was added.
addGroup	Adds a new end-user group to the portal.
answerCaptcha	Retrieves the user's answer to the captcha.
answerRecoverCaptcha	Answers a user's submission of a password recovery captcha.
applyAutoAssignmentRules	Applies automatic template assignment rules.
attachDevice	Connects a device to the portal.
cancelFileManagerTask	Cancels the FileManager task.
cancelTask	Cancels a task.
changeSystemAdminPassword	Changes the administrator password for the portal.
checkUsername	Validates the username when a user logs into the portal.
checkUsernameAndMail	Checks if a submitted user name and email address already exist in the portal.
copyLink	Copies a public link to a folder or file.
copyResources	Copies the user's resources (files and folders).
createFolderGroup	Creates a new folder group.
createShare	Creates a shared object, which contains the files and folders that were shared with specified people.
customizeTemplate	Customizes a template.
delete	Deletes a portal.
deleteAllFolders	Deletes all the folders in the portal.
deleteCloudDrivePolicyRules	Deletes a cloud policy rule.
deleteFilesFromQuarantine	Deletes files from the quarantine.
deleteResources	Deletes the user's resources (files and folders).
deleteShare	Deletes the shared object, which contains the files and folders that were shared with specified people.
fetchGroups	Retrieves groups from Active Directory.
fetchResources	Fetches the user's resources (files and folders).
generateAdminReport	Generates an Administrator Report for a portal.
generateReport	Generates a report for this portal. See Generating Reports.
getADTrustedDomains	Retrieves all trusted Active Directory domains.
getAllowedDeviceTypes	Retrieves all allowed device types.
getAntivirusGlobalStatus	Retrieves the antivirus status for the entire portal.
getAutoAssignmentRules	Retrieves all automatic template assignment rules.
getdefaultFirmwareUrl	Retrieves the URL of the default firmware.
getDefaultPlan	Retrieves the default plan to which new users are subscribed.
getDeviceAdminUsername	Retrieves the administrator user name of a device.
getDomains	Retrieves all domains.
getEmailFromInvitation	Retrieves the email from the invitation.
getFeatures	Retrieves the set of features supported by the portal.
getFirmwares	Retrieves all firmwares.
getGlobalPlans	Retrieves all global plans.
getNFSFolderSeedingInfo	Retrieves seeding information from an NFS folder.
getPlanAutoAssignmentRules	Retrieves all automatic plan assignment rules.
getPlanDescription	Retries the plan description.
getPortalAddons	Retrieves a list of the portal's addons.
getPortalExtendedStatus	Retrieves the statuses all the reseller portals.
getPortals	Retrieves all portals.
getQuarantineGlobalStatus	Checks the status of the quarantine of the entire portal.
getSeedingStations	Retrieves a list of seeding stations configured for the portal.
getSettings	Retrieves a portal's settings.
getShareDetails	Retrieves the details of a shared object, which contains the files and folders that were shared with specified people.
getStatistics	Retrieves portal statistics.
getTaskStatus	Retrieves a task's status.
getTemplate	Retrieves a template.
getTemplates	Retrieves all email notification templates.
getUpdatedFoldersList	Retrieves a list of the portal's folders.
hideNotifications	Hide the portal notifications.
importNFSFolder	Imports a folder from an NFS server.
importS3Folder	Imports a folder from an S3 storage node.
inviteToRegister	Sends an invitation to register to the portal.
isValidPhoneNumber	checks whether the specified phone number is valid.
listPublicShares	Lists the resources that the user shared publicly (files and folders).
listShares	Lists the resources that the user shared (files and folders).
listVersions	Lists all versions of an infected item.
makeCollection	Creates a collection of the user's resources (files and folders).
moveResources	Moves the user's resources (files and folders).
notifyChange	Notifies all servers in the system of some change.
queryLogs	Queries the CTERA Portal logs.
registerUser	Registers the specified user to the portal.
removeAddon	Removes an addon from a portal.
removeCloudDrive	Deletes a cloud drive from the portal.
removeDefaultDeviceTemplate	Removes the default device template.
removeDefaultPlan	Removes the default plan to which new users are subscribed.
removeDefaultSkin	Removes the currently applied skin.
rescanFilesFromQuarantine	Rescans the files in the quarantine.
resend	Resends the details of a shared object, which contains the files and folders that were shared with specified people.
resendVerificationCode	Sends the verification code again.
restoreResources	Restores the user's resources (files and folders).
saveAndFetchADUsers	Saves Active Directory connection settings and fetches users from an Active Directory domain.
searchAD	Searches Active Directory.
setAutoAssignmentRules	Modifies automatic template assignment rules.
setPlanAutoAssignmentRules	Modifies automatic plan assignment rules.
setSettings	Modifies a portal's settings.
shareResources	Shares the user's resources (files and folders).
subscribe	Subscribes the portal to a plan.
syncAD	Synchronizes CTERA Portal with Active Directory.
testAndSaveAD	Verifies connection to the specified Active directory domain, and saves the new setting if successful.
unCustomizeTemplate	Resets a template to its default settings, removing all customizations.
unhideNotifications	Unhide the portal notifications.
unsubscribe	Unsubscribes the portal from a plan.
updateAccounts	Updates user accounts.
updateShare	Updates a shared object that contains the files and folders that are shared with specified people.
updateSkinCache	Updates the skin cache of the portal.
validateCurrentLoggedInUserPassword	Validates the username and password of a currently logged-in user.
validateVoucher	Validates the voucher.
verifyVerificationCode	Verifies the verification code that the user used to register to the portal.

XML Encoding Example

<val>portalname</val>

</att>

<val>reseller</val>

</att>

</att>

<val>enabled</val>

</att>

<val>false</val>

</att>

<val>false</val>

</att>

</obj>

</att>

</obj>

</att>

</obj>

ResellerPortalNewUserSettings

Represents settings of a new user in a reseller portal.

Attributes

backupDeduplicationLevel	ResellerPortalDeduplicationLevel	The deduplication level to use for a new reseller portal user's backup folder. See ResellerPortalDeduplicationLevel. The default value is User.
cloudDriveDeduplicationLevel	ResellerPortalDeduplicationLevel	The default deduplication level to use for a new reseller portal user's cloud drive folder. See ResellerPortalDeduplicationLevel. The default value is User.

ResellerPortalSpecificSettings

Represents specific settings of a reseller portal.

Attributes

resellerPortalNewUserSettings	ResellerPortalNewUserSettings	The settings for a new user of a reseller portal. See ResellerPortalNewUserSettings.
portalAdminHelpUrl	string	The default URL for accessing portal help. The default value is http://www.ctera.com/help/portal/version/staff/.

RetentionPolicy

Represents a plan's snapshot retention policy.

Attributes

retainAll	Integer	The number of hours to retain all snapshots. Every snapshot is retained for this amount of time. After this time has passed for any given snapshot, the snapshot may be retained or deleted depending on the other settings. The minimum value is 1. The default value is 24.
hourly	Integer	The number of hourly snapshots that should be retained. The minimum value is 1. The default value is 24.
daily	Integer	The number of daily snapshots that should be retained. The minimum value is 2. The default value is 7.
weekly	Integer	The number of weekly snapshots that should be retained. The minimum value is 0. The default value is 4. This attribute is optional.
monthly	Integer	The number of monthly snapshots that should be retained. The minimum value is 0. The default value is 0. This attribute is optional.
quarterly	Integer	The number of quarterly snapshots that should be retained. The minimum value is 0. The default value is 0. This attribute is optional.
yearly	Integer	The number of yearly snapshots that should be retained. The minimum value is 0. The default value is 0. This attribute is optional.
retainDeleted	Integer	The numbers of days to keep files or folders that were deleted by the user. During this time the user can restore the file. The minimum value is 30. The default value is 30.

RolesSettings

Represents the settings of all the portal user roles.

Attributes

readWriteAdminSettings	PortalRoleSettings	A PortalRoleSettings object. The default value is a role named ReadWriteAdmin, defined to allow users access to end user folders, permission to change user email addresses, permission to manage and change user passwords, permission to change settings of virtual portals, permission to change users' roles. This role does not give Super User permission to users and does not allow users to perform Single Sign On on behalf of users.
readOnlyAdminSettings	PortalRoleSettings	A PortalRoleSettings object. The default value is a role named ReadOnlyAdmin, defined to allow users access to end user folders, but does not allow users to change user email addresses, manage and change user passwords, change settings of virtual portals, or change users' roles.
supportAdminSettings	PortalRoleSettings	A PortalRoleSettings object. The default value is a role named Support, defined to allow users permission to manage and change users' email addresses and passwords and perform seeding imports and seeding exports. This role does not allow users permission to access end user folders, change settings of virtual portals, or change roles.

SamlSettings

Represents information about scheduling a task, for devices assigned to a specific device configuration template.

This class extends the SSOSettings class.

Attributes

entityId	String	The identity provider that issues the SAML assertion.
signInUrl	String	The URL that CTERA Portal redirects to when signing in. You get this from the provider.
logOutUrl	String	The URL that CTERA Portal redirects to when logging out of the portal.
isSPInitiated	Boolean	Set this attribute to true to use SAML service provider initiated login method. Otherwise, set this attribute to false. The default value is false.
claimAttributeSuffixToUse	String	The suffix of the attribute in the XML of the SAML response. The attribute is the unique identifier value. Normally the attribute is not used and the nameId attribute is used.
enableEndpointsDirectAuthentication	Boolean	Set this attribute to true to enable connecting end-point devices using the device username and password, when SAML single sign-on is implemented. Otherwise, set this attribute to false. The default value is false.

ScheduleTopic

Represents information about scheduling a task, for devices assigned to a specific device configuration template.

This class extends the ConfigTopic class.

Attributes

schedule

TaskSchedule

A TaskSchedule object.

The default value is to perform the task every 24 hours.

Attributes Inherited from the Parent Class ConfigTopic

overrideTemplate

Boolean

Set this attribute to true to override the template settings. Otherwise, set this attribute to false to use the template settings.

The default value is false.

SessionTokenParams

Represents the access tokens for a user to sign on using SSO.

Attributes

username	String	The username for single sign-on.
portal	String	The name of the portal where the user is defined.

Skin

Represents a skin.

This class extends the BaseObject class.

Attributes

customCSS	Boolean	Set this attribute to true to indicate that this skin includes a custom CSS. Otherwise, set this attribute to false. The default value is false.
customLogin	Boolean	Set this attribute to true to indicate that this skin includes a custom Login page. Otherwise, set this attribute to false. The default value is false.
size	Integer	The *.skin file's size in Kb.
isDefault	Boolean	Set this attribute to true to indicate that this skin is the default skin. Otherwise, set this attribute to false. The default value is false.
uri	String	The URI of the skin. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

setAsDefault	Sets the skin as the default skin.
updateSkinCache	Updates the skin in the skin cache.

Snapshot

Represents a snapshot.

Attributes

startTime	dateTime	The time at which the snapshot was created.
backupRC	GenericRC	The result of the process which created this snapshot, represented by a GenericRC object. See GenericRC. This attribute is optional.
backupError	String	The error message with which the process of creating this snapshot ended. This attribute is optional.
endTime	dateTime	The time at which the snapshot was closed. This attribute is optional.

SoftwareUpdatesTopic

This class is currently undocumented. For additional information, contact CTERA support.

SSOSettings

Represents the base class for single sign-on.

StorageLocationStatistics

Represents statistics for a storage node in the Storage Report.

Attributes

locationName	String	The name of the storage node.
locationType	String	The storage node's type.
readOnly	Boolean	Set to true if no new blocks are written to the storage node. Otherwise, set to false.
blocksStorageSpace	Integer	The amount of storage space available on this storage node in MB. This attribute is optional.
mapfileOverhead	Integer	The amount of space consumed by the mapfiles for this server in MB. This attribute is optional.
uploadedBlocks	Integer	The number of uploaded blocks in this storage node. This attribute is optional.
missingBlocks	Integer	The number of missing blocks in this storage node. This attribute is optional.
totalMapfiles	Integer	The total number of mapfiles in this storage node. This attribute is optional.
missingMapfiles	Integer	The number of missing mapfiles in this storage node. This attribute is optional.
inUploadBlocks	Integer	The number of blocks currently being uploaded to the storage node. This attribute is optional.
inUploadMapfiles	Integer	The number of mapfiles currently being uploaded to this storage node. This attribute is optional.

StorageLocationsStatisticsReport

Represents a Storage Report.

This class extends the Report class.

Attributes

statistics

StorageLocationStatistics[]

An array StorageLocationStatistics objects.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

XML Encoding Example

</att>

</att>

<val>storageLocationsStatisticsReport</val>

</att>

<list>

</att>

</att>

</att>

<val>MainBackup</val>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</att>

</obj>

</list>

</att>

</att>

</obj>

SyncThrottlingSettings

Represents settings for restricting throughput when syncing a cloud drive.

Attributes

inKbitsPerSecond	Integer	The maximum bandwidth to use for downloading files from the cloud drive for syncing, in kilobytes per second. The minimum value is 8. This attribute is optional.
outKbitsPerSecond	Integer	The maximum bandwidth to use for uploading files to the cloud drive for syncing, in kilobytes per second. The minimum value is 8. This attribute is optional.
schedule	TimeRange	A TimeRange object, which specifies when cloud drive sync bandwidth should be throttled. This attribute is optional.

SyncThrottlingTopic

Represents information about restricting the amount of bandwidth used for syncing cloud drive files.

Attributes

throttling

SyncThrottlingSettings

A SyncThrottlingSettings object.

This attribute is optional.

TaskSchedule

Represents the schedule for a task.

Attributes

mode	ScheduleType	The schedule mode. See ScheduleType. The default value is daily.
hourly	HourlySchedule	An HourlySchedule object. This attribute is optional.
daily	DailySchedule	A DailySchedule object. This attribute is optional.
weekly	WeeklySchedule	A WeeklySchedule object. This attribute is optional.
monthly	MonthlySchedule	A MonthlySchedule object. This attribute is optional.
interval	IntervalSchedule	An IntervalSchedule object. This attribute is optional.
window	TimeRange	A TimeRange object. This attribute is optional.

TeamPortal

Represents a team portal.

This class extends the Portals class.

Attributes

notifications	Notification[]	An array of Notification objects. By default, all notifications are enabled except Backup Completed Successfully and User Report, which are disabled.
disableTeamQuotaEnforcement	Boolean	Set to true to disable the enforcement of a storage quota per team portal. The default value is false.

Attributes Inherited from the Parent Class Portal

portalType	PortalObjType	The portal's type. See PortalObjType. The default value is reseller.
devices	ManagedDevice[]	An array of ManagedDevice objects. This attribute is optional. It should be omitted when creating a new portal.
domains	Domain[]	An array of Domain objects. This attribute is optional. It should be omitted when creating a new portal.
users	PortalUser[]	An array of PortalUser objects. This attribute is optional. It should be omitted when creating a new portal.
plans	Plan[]	An array of Plan objects. This attribute is optional.
localGroups	PortalGroup[]	An array of PortalGroup objects. This attribute is optional.
foldersGroups	FoldersGroup[]	An array of FoldersGroup objects. This attribute is optional. It should be omitted when creating a new portal.
backups	Backup[]	An array of Backup objects. This attribute is optional.
cloudDrives	CloudDrive[]	An array of CloudDrive objects. This attribute is optional.
projects	PortalProject[]	An array of PortalProject objects.
invites	PortalInvitation[]	An array of PortalInvitation objects. This attribute is optional.
deviceTemplates	DeviceTemplate[]	An array of DeviceTemplate objects. This attribute is optional.
skins	Skin[]	An array of Skin objects. This attribute is optional.
templates	CustomizedTemplate[]	An array of CustomizedTemplate objects. This attribute is optional.
deviceTemplatesAutoAssignmentRules	DeviceTemplateAutoAssignmentRule[]	An array of DeviceTemplateAutoAssignmentRule objects. This attribute is optional.
PlanAutoAssignmentRules	PlanAutoAssignmentRule[]	An array of PlanAutoAssignmentRule objects. This attribute is optional.
settings	PortalSettings	A PortalSettings object. This attribute is optional.
cloudDrivePolicyRule	CloudDrivePolicyRule[]	An array of CloudDrivePolicyRule objects. This attribute is optional.
rolesSettings	RolesSettings	A RolesSettings object.
portalStats	PortalStats	A PortalStats object. The default value is 0 for all statistics. This attribute is optional and read-only. It should be omitted when creating a new portal.
alerts	AlertRule[]	An array of AlertRule objects. This attribute is optional.
reports	Report[]	An array of Report objects. This attribute is optional and read-only. It should be omitted when creating a new portal.
logs	Log[]	An array of Log objects. This attribute is optional and read-only. It should be omitted when creating a new portal.
dnsName	String	The DNS name of the CTERA Portal. This attribute is optional.
enableResellerProvisioning	Boolean	Set this attribute to true to enable provisioning a reseller portal. Otherwise, set this attribute to false. The default value is true.
plan	Ref	A link to the global plan assigned to this portal. This attribute is optional.
expirationDate	Date	The expiration date of the global plan assigned to this portal. This attribute is optional.
expired	Boolean	Set this attribute to true to indicate that the global plan assigned to this portal has expired. Otherwise, set this attribute to false. The default value is false.
portalAddOns	UserAddOn[]	An array of UserAddOn objects. This attribute is optional.
sla	EffectiveSLA	An EffectiveSLA object. This attribute is optional.
defaultGroup	Ref	A link to the default folder group of this portal. This attribute is optional. It is relevant for team portals only.
ipBasedAccessControl	IpRange[]	An array of IpRange objects. This attribute is optional.
directoryConnector	DirectoryConnector	A DirectoryConnector object. This attribute is optional._
PortalDisplayInfo	String	The virtual portal owner's billing ID. This attribute is optional.
firstTimeConfiguration	Boolean	This attribute is used to change the portal name on first login. It should not be used by default. This attribute is optional.
useKerberos	Boolean	Set to true to use the Kerberos protocol for authentication when communicating with an Active Directory domain. The default value is false. This attribute is optional.
catalogNode	Ref	A link to the virtual portal's catalog node server. Catalog node servers are database servers that store metadata. CTERA Portal supports multiple catalog node servers for scalability. The default is to randomly select any catalog node. This attribute is optional.
activationStatus	PortalActivationStatus	The portal's activation status. See PortalActivationStatus. The default value is Enabled.
portalNotifications	PortalNotification[]	An array of PortalNotification objects. This attribute is optional.
projectManagePermissions	ProjectManagementPermissionRule[]	An array of ProjectManagementPermissionRule objects that define the permissions for each project in the portal. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

Extended Methods

changePortalName	Changes the name of the portal.
searchCollaborationMembers	Searches for project members that have permissions to work on the Team Portal files and folders.

Extended Methods Inherited from the Parent Class Portal

addAddon	Adds an addon for a portal.
addAttachmentsFolderReturnId	Returns the ID of the attachments folder that was added.
addCloudDrive	Adds a cloud drive to the portal.
addCloudDrivePolicyRule	Adds a cloud policy rule.
addCloudDriveReturnID	Returns the ID of the cloud device that was added.
addGroup	Adds a new end-user group to the portal.
answerCaptcha	Retrieves the user's answer to the captcha.
answerRecoverCaptcha	Answers a user's submission of a password recovery captcha.
applyAutoAssignmentRules	Applies automatic template assignment rules.
attachDevice	Connects a device to the portal.
cancelFileManagerTask	Cancels the FileManager task.
cancelTask	Cancels a task.
changeSystemAdminPassword	Changes the administrator password for the portal.
checkFileSizeBeforeUpload	Check the file size before starting to upload.
checkUsername	Validates the username when a user logs into the portal.
checkUsernameAndMail	Checks if a submitted user name and email address already exist in the portal.
copyLink	Copies a public link to a folder or file.
copyResources	Copies the user's resources (files and folders).
createFolderGroup	Creates a new folder group.
createNewOfficeFile	Creates a new Microsoft Office Online file.
createShare	Creates a shared object, which contains the files and folders that were shared with specified people.
customizeTemplate	Customizes a template.
delete	Deletes a portal.
deleteAllFolders	Deletes all the folders in the portal.
deleteCloudDrivePolicyRules	Deletes a cloud policy rule.
deleteFilesFromQuarantine	Deletes files from the quarantine.
deleteResources	Deletes the user's resources (files and folders).
deleteShare	Deletes the shared object, which contains the files and folders that were shared with specified people.
fetchGroups	Retrieves groups from Active Directory.
fetchResources	Fetches the user's resources (files and folders).
generateAdminReport	Generates an Administrator Report for a portal.
generateReport	Generates a report for the portal. See Generating Reports.
getADTrustedDomains	Retrieves all trusted Active Directory domains.
getAllowedDeviceTypes	Retrieves all allowed device types.
getAntivirusGlobalStatus	Retrieves the antivirus status for the entire portal.
getAutoAssignmentRules	Retrieves all automatic template assignment rules.
getAvailableAddOnItems	Get the license types addons can use. When creating or modifying an add-on, if a license does not exist it won't appear in the list.
getAvailablePlanItems	Get the license types plans can use. When creating or modifying a plan, if a license does not exist it won't appear in the list.
getCloudDrivePolicy	Get the cloud drive policy.
getCollaborationPermissions	Get the collaboration permissions.
getCollaborationPolicy	Get the collaboration policy.
getdefaultFirmwareUrl	Retrieves the URL of the default firmware.
getDefaultPlan	Retrieves the default plan to which new users are subscribed.
getDeviceAdminUsername	Retrieves the administrator user name of a device.
getDomains	Retrieves all domains.
getEmailFromInvitation	Retrieves the email from the invitation.
getFeatures	Retrieves the set of features supported by the portal.
getFirmwares	Retrieves all firmwares.
getGlobalPlans	Retrieves all global plans.
getGlobalSystemStatus	Determine if the portal is in critical storage mode. For example, an end user logs in to the portal, and If the portal is in critical storage mode a notification is displayed.
getNFSFolderSeedingInfo	Retrieves seeding information from an NFS folder.
getOfficeOnlineUrl	Retrieves the Microsoft Office Online Discovery URL.
getPlanAutoAssignmentRules	Retrieves all automatic plan assignment rules.
getPlanDescription	Retries the plan description.
getPortalAddons	Retrieves a list of the portal's addons.
getPortalExtendedStatus	Retrieves the statuses all the team portals.
getPortals	Retrieves all portals.
getQuarantineGlobalStatus	Checks the status of the quarantine of the entire portal.
getSeedingStations	Retrieves a list of seeding stations configured for the portal.
getSettings	Retrieves a portal's settings.
getShareDetails	Retrieves the details of a shared object, which contains the files and folders that were shared with specified people.
getSsoSettings	Get the single sign-on settings.
getStatistics	Retrieves portal statistics.
getTaskStatus	Retrieves a task's status.
getTemplate	Retrieves a template.
getTemplates	Retrieves all email notification templates.
getUpdatedFoldersList	Retrieves a list of the portal's folders.
hideNotifications	Hide the portal notifications.
importNFSFolder	Imports a folder from an NFS server.
importS3Folder	Imports a folder from an S3 storage node.
inviteToRegister	Sends an invitation to register to the portal.
isValidPhoneNumber	checks whether the specified phone number is valid.
leaveShare	Leave a share that was shared.
listPublicShares	Lists the resources that the user shared publicly (files and folders).
listShares	Lists the resources that the user shared (files and folders).
listSnapshots	List all snapshots.
listVersions	Lists all versions of an infected item.
makeCollection	Creates a collection of the user's resources (files and folders).
moveResources	Moves the user's resources (files and folders).
notifyChange	Notifies all servers in the system of some change.
queryLogs	Queries the CTERA Portal logs.
registerUser	Registers the specified user to the portal.
removeAddon	Removes an addon from a portal.
removeCloudDrive	Deletes a cloud drive from the portal.
removeDefaultDeviceTemplate	Removes the default device template.
removeDefaultPlan	Removes the default plan to which new users are subscribed.
removeDefaultSkin	Removes the currently applied skin.
rescanFilesFromQuarantine	Rescans the files in the quarantine.
resend	Resends the details of a shared object, which contains the files and folders that were shared with specified people.
resendVerificationCode	Sends the verification code again.
restoreResources	Restores the user's resources (files and folders).
saveAndFetchADUsers	Saves Active Directory connection settings and fetches users from an Active Directory domain.
searchAD	Searches Active Directory.
searchLocalAndDomainMembers	Search for both local and Active Directory users.
searchSharingUsers	Search the sharing users.
setAutoAssignmentRules	Modifies automatic template assignment rules.
setCloudDrivePolicy	Set the cloud drive policy.
setCollaborationPermissions	Set the collaboration permissions.
setCollaborationPolicy	Set the collaboration policy.
setPlanAutoAssignmentRules	Modifies automatic plan assignment rules.
setSettings	Modifies a portal's settings.
setSsoSettings	Modify the single sign-on settings.
shareResources	Shares the user's resources (files and folders).
subscribe	Subscribes the portal to a plan.
syncAD	Synchronizes CTERA Portal with Active Directory.
testAndSaveAD	Verifies connection to the specified Active directory domain, and saves the new setting if successful.
unCustomizeTemplate	Resets a template to its default settings, removing all customizations.
unhideNotifications	Unhide the portal notifications.
unsubscribe	Unsubscribes the portal from a plan.
updateAccounts	Updates user accounts.
updateShare	Updates a shared object that contains the files and folders that are shared with specified people.
updateSkinCache	Updates the skin cache of the portal.
validateCurrentLoggedInUserName	Validates the username of a currently logged-in user.
validateCurrentLoggedInUserPassword	Validates the password of a currently logged-in user.
validateVoucher	Validates the voucher.
verifyVerificationCode	Verifies the verification code that the user used to register to the portal.

XML Encoding Example

<val>portalname</val>

</att>

</att>

</obj>

TeamPortalNewUserSettings

Represents settings of a new user in a team portal.

Attributes

backupDeduplicationLevel	TeamPortalDeduplicationLevel	The default deduplication level to use for a new team portal user's backup folder. See TeamPortalDeduplicationLevel. The default value is User.
cloudDriveDeduplicationLevel	TeamPortalDeduplicationLevel	The default deduplication level to use for a new team portal user's cloud drive folder. See TeamPortalDeduplicationLevel. The default value is User.

TeamPortalSpecificSettings

Represents specific settings for a team portal.

Attributes

enableProjectsFolders	Boolean	Set to true to enable team portal members to create collaboration projects. The default value is true.
projectsFolderName	noSlashStr	The name of the projects folder. The projects folder is a folder with allowed read access to all users. The default value is projects.
enableSharingPersonalFolders	Boolean	Set to false to disable sharing of personal folders for team portal members. The default value is true.
sharingFolderName	noSlashStr	The name of the folder under which shared files and folders appear in a team portal member’s cloud drive. The default value is shared with me.
portalAdminHelpUrl	Str	The URL where the team portal administration documentation is located. The default value is: http://www.ctera.com/help/portal/version/team/
teamPortalNewUserSettings	TeamPortalNewUserSettings	The settings of a new user in a team portal. See TeamPortalNewUserSettings.

TemplateFirmware

Represents a firmware in a device configuration template.

Attributes

type	String	The firmware's device platform.
firmware	Ref	A link to the firmware object.

ThrottlingSettings

Represents settings for restricting the amount of bandwidth used for backing up files online.

Attributes

kbitsPerSecond	Integer	The maximum bandwidth to use for cloud backups, in kilobytes per second. The minimum value is 8. This attribute is optional.
schedule	TimeRange	A TimeRange object, which specifies when throttling should be used. This attribute is optional.

ThrottlingTopic

Represents information about restricting the amount of bandwidth used for backing up files online, for devices assigned to a specific device configuration template.

This class extends the ConfigTopic class.

Attributes

throttling

ThrottlingSettings

A ThrottlingSettings object.

This attribute is optional.

TimeRange

Represents a schedule for running a task.

Attributes

days	DayOfWeek[]	The days of the week during which to perform the task. See DayOfWeek. This attribute is optional.
start	Time	The starting time for the task.
end	Time	The ending time for the task. This attribute is optional.
termOnEnd	Boolean	Set this attribute to true to terminate the operation at the end of the time range. Otherwise, set this attribute to false. The default value is false. This attribute is optional.

TotalConnectionStatus

Represents the connection status of a virtual portal.

Attributes

connected	Integer	The number of devices that are currently connected to the portal.
notConnected	Integer	The number of devices that are currently not connected to the portal.
total	Integer	The total number of devices defined in the portal. This attribute is optional.

TotalStatus

Represents the storage status of devices in a virtual portal.

Attributes

optimal	Integer	The total number of devices with drives that are not in a RAID array and are in optimal condition.
rebuilding	Integer	The total number of devices with drives that are in a RAID array are currently being rebuilt.
degraded	Integer	The total number of devices with drives that are degraded.
syncing	Integer	The total number of devices with drives that are in a RAID array and are currently syncing.
failed	Integer	The total number of devices with drives that have failed.
unknown	Integer	The total number of devices with drives that contains unrecognized data.

TotalStorage

Represents the storage status of a virtual portal.

Attributes

totalAvailable	Integer	The total amount of storage space available in this virtual portal.
totalInUse	Integer	The total amount of storage space used in this virtual portal.
totalSpare	Integer	The total amount of unused storage space in this virtual portal.

TrustSecurityCode

Represents a security code that is sent to a user in an invitation for accessing shared files or folders.

Attributes

encodedUser	String	The name of the user who has a code.
code	String	The code.
expiresOn	dateTime	The expiry time of the code.

UserAddOn

Represents information about an addon to which a user account is subscribed.

This class is relevant for reseller portals only.

Attributes

addon	Ref	A link to the addon to which the user account is subscribed.
startDate	Date	The date representing the start of the addon subscription period.
endDate	Date	A date representing the end of the addon subscription period. This attribute is optional.
externalItemId	String	An optional unique ID for this addon. This ID can later be referenced by client, in order to delete the addon. This attribute is optional.
comment	String	Comments about the addon. This attribute is optional.
displayName	String	This attribute is optional.
name	String	Name of the addon. This attribute is optional.

Voucher

Represents a voucher.

This class extends the BaseObject class. It is relevant for reseller portals only.

Attributes

addOn	Ref	A link to the addon or subscription plan to which the voucher applies.
code	String	The voucher's code.
isUsed	Boolean	Set this attribute to true to indicate that the voucher has been redeemed by a user, and is no longer available to be redeemed by other users. Otherwise, set it to false to indicate that the voucher has not yet been redeemed. The default value is false.
redeemDate	dateTime	The date on which the voucher was redeemed. This attribute is optional.
redeemer	Ref	A link to the user account that redeemed the voucher. This attribute is optional.

Attributes Inherited from the Parent Class BaseObject

uid	Integer	The object's unique ID. This attribute is optional. Do not specify it when creating a new object; it is filled in automatically.
name	objName	The object's name.
domain	String	The Active Directory domain to which the object belongs. This attribute is optional.
displayName	String	The name to use when displaying this object in the End User Portal and notifications. This attribute is optional.
portal	Ref	A link to the virtual portal with which the object is associated. This attribute should not be provided when creating new objects. This attribute is optional.
owner	Ref	A link to the object's owner. This attribute is optional.
createDate	dateTime	The date on which the object was created. This attribute is optional. Do not specify this attribute when creating a new object; it is filled in automatically.
modifiedDate	dateTime	The date on which the object was last modified. This attribute is optional. Do not specify this attribute when modifying an object; it is updated automatically.
comment	String	A comment about the object. This attribute is optional.
baseObjectRef	String	A reference to the DB object. This attribute is optional. Do not specify this attribute when modifying an object; it is calculated automatically.
owner	Ref	A link to the cloud folder's owner. This attribute is optional.

WatermarkSettings

A customized watermark and footnote added to shared files restricted to previewing.

Attributes

enabled	Boolean	Set this attribute to true to set a watermark. Otherwise, set this attribute to false. The default value is true.
text	String	The text displayed on each page of a file restricted to previewing only. The default is ${company} CONFIDENTIAL.
color	String	The text color. The default is #FF0000. The maximum value is 100.
opacity	Integer	The level of opacity of the text. The less the opacity the fainter the text. The default is 50. The value must be between 10 and 90.
fontSize	Integer	The size of the text to use. The default is 36. The value must be between 8 and 48.

WeeklySchedule

Represents a schedule for automatically backing up files every week.

Attributes

day	DayOfWeek	A DayOfWeek object.
hour	Integer	The hour at which the task should be executed. The value must be between 0 and 23.
minute	Integer	The minute at which the task should be executed. The value must be between 0 and 59.