Config1_User

Properties

Methods

Property Details

accessControl :String

Description:

• Access control setting for this user which must be 'Non-Windows' or 'Windows'. If it's set to 'Windows', then the user's file-access permissions will be controlled by Windows. Otherwise, those will be controlled by CompleteFTP.

  Note that Windows users may have their permissions controlled by Windows or CompleteFTP but the permissions of non-Windows users are always controlled by CompleteFTP.

Type:

• String

(readonly) createdTime :Date

Description:

• Date and time when the user was created.

Type:

• Date

description :String

Description:

• The description of this user.

Type:

• String

email :String

Description:

• A user's e-mail address may be used in e-mail notifications.

Type:

• String

enabled :Boolean

Description:

• Is this user currently enabled?

Type:

• Boolean

expiryDate :Date

Description:

• The user's expiry date. After this date the user cannot log in, which is useful for temporary users.

Type:

• Date

fileEncryptionMode :String

Description:

• File encryption mode setting for this user which must be 'GlobalEncryption' or 'EncryptionOff'. If it's set to 'GlobalEncryption' and the site also has the equivalent setting enabled (see Config1_Site.fileEncryptionMode), all files transferred to the server by this user will be encrypted on the server (encryption at rest). The only way to decrypt files is by transferring them from the server, or via an administrator command.

Type:

• String

ftpEnabled :Boolean

Description:

• Is the FTP protocol enabled for this user?

Type:

• Boolean

ftpsEnabled :Boolean

Description:

• Is the FTPS protocol enabled for this user? If Config1_User.ftpEnabled is false and Config1_User.ftpsEnabled is true, then clients must connect using FTPS.

Type:

• Boolean

fullName :String

Description:

• The full name of this user.

Type:

• String

homeDirIsRoot :Boolean

Description:

• If this option is enabled then the user will see their home folder as the root (i.e. /) for any site they connect to. If it is disabled then the user will see the absolute virtual file-system path.

Type:

• Boolean

httpEnabled :Boolean

Description:

• Is the HTTP protocol enabled for this user?

Type:

• Boolean

httpsEnabled :Boolean

Description:

• Is the HTTPS protocol enabled for this user?

Type:

• Boolean

(readonly) id :String

Description:

• The ID of this user.

Type:

• String

(readonly) inbuilt :Boolean

Description:

• Is this an inbuilt user who is created automatically during installation?

Type:

• Boolean

jssEnabled :Boolean

Description:

• Is Server-Side Javascript (JSS) enabled for this user? If it is, then JSS will be enabled for .jss files in folders owned by this user.

  JSS must also be enabled for the site serving up the page (see Config1_Site.storeEncryptedPasswords is disabled.

  Note that this property is not required for Windows users.

Type:

• String

(readonly) passwordHash :String

Description:

• The hash of this user's password.

Type:

• String

quotaSpeedDownload :Number

Description:

• A user's bandwidth quota can be set for download, meaning that if the set rate is exceeded, the download will be slowed down.

  Note that bandwidth quotas are per site, so if in the Enterprise Edition a user is enabled on two sites, they will have double the bandwidth compared to a single site.

  The default is zero means unlimited, and the value is entered in bytes/second.

Type:

• Number

quotaSpeedUpload :Number

Description:

• A user's bandwidth quota can be set for upload, meaning that if the set rate is exceeded, the upload will be slowed down.

  Note that bandwidth quotas are per site, so if in the Enterprise Edition a user is enabled on two sites, they will have double the bandwidth compared to a single site.

  The default is zero means unlimited, and the value is entered in bytes/second.

Type:

• Number

quotaStorage :Number

Description:

• A user's disk quota can be set, meaning that uploads will fail if the quota is exceeded. The disk quota is a cumulative limit across all sites (in the Enterprise Edition).

  The default is zero means unlimited, and the value is entered in bytes.

Type:

• Number

readOnly :Boolean

Description:

• If this flag is set then the user will be unable to make upload, delete and rename files and folders.

Type:

• Boolean

scpEnabled :Boolean

Description:

• Is the SCP protocol enabled for this user?

Type:

• Boolean

sftpEnabled :Boolean

Description:

• Is the SFTP protocol enabled for this user?

Type:

• Boolean

sharingEnabled :Boolean

Description:

• Is File sharing enabled for this user? It must be enabled for users to begin using CompleteBox to share their files.

  The CompleteFTP site must have sharing enabled (see Config1_Site.sharingEnabled).

Type:

• Boolean

siteMapping :Array.<Config1_SiteMapping>

Description:

• An array of Config1_SiteMapping objects represents the sites and home folders setting for this user.

Type:

• Array.<Config1_SiteMapping>

sshAuthMethods :Array.<String>

Description:

• An array of SSH authentication methods ('Password' | 'PublicKey' | 'PublicKeyAndPassword' | 'All') available for this user.

  The SSH authentication methods are also specified at the site level (see Config1_Site.sshAuthMethods). When a user logs in, only the authentication methods specified at both levels are available. For example, if the site permits password only, and the user permits password and publickey, then only password will be available.

Type:

• Array.<String>

sshForwardingEnabled :Boolean

Description:

• Is local SSH TCP/IP forwarding enabled for this user? If it is, then local (to a client machine) SSH tunnels can be established between a client and CompleteFTP, and data will be forwarded on to the host specified when the tunnel was set up. On the client side, the tunnel must be set up by an SSH utility such as PuTTY.

Type:

• Boolean

sshPublicKeyDSA :Array.<String>

Description:

• An array of DSA public keys in OpenSSH format that the user may use to authenticate with.

Type:

• Array.<String>

sshPublicKeyECDSA :Array.<String>

Description:

• An array of ECDSA public keys in OpenSSH format that the user may use to authenticate with.

Type:

• Array.<String>

sshPublicKeyRSA :Array.<String>

Description:

• An array of RSA public keys in OpenSSH format that the user may use to authenticate with.

Type:

• Array.<String>

sshTerminalEnabled :Boolean

Description:

• Is SSH terminal access enabled for this user? If it is, SSH terminal access must be enabled for the site as well as the user (see Config1_Site.sshTerminalEnabled). Non-Windows users cannot use 'exec' in the terminal to minimize security risks.

Type:

• Boolean

sshTerminalShell :String

Description:

• Determines which type of console interface (shell) the user is placed into when they connect with SSH terminal. Currently 'UNIX' and 'JSS' are supported.

Type:

• String

(readonly) type :String

Description:

• The type of this user. This must be 'Windows' or 'Non-Windows'.

Type:

• String

userName :String

Description:

• The user-name of this user. This is the name they must log in with.

Type:

• String

Method Details

remove()

Description:

• Deletes this user.