Properties
| Property | Type | Description |
|---|---|---|
| accessControl | String | Access control setting for this user which must be 'Non-Windows' or 'Windows'. |
| createdTime | Date | Date and time when the user was created. |
| description | String | The description of this user. |
| String | A user's e-mail address may be used in e-mail notifications. |
|
| enabled | Boolean | Is this user currently enabled? . |
| expiryDate | Date | The user's expiry date. |
| filesEncryptedAtRest | Boolean | File encryption mode setting for this user which must be 'GlobalEncryption' or 'EncryptionOff'. |
| ftpEnabled | Boolean | Is the FTP protocol enabled for this user? . |
| ftpsEnabled | Boolean | Is the FTPS protocol enabled for this user? If 'PublicKey' | 'PublicKeyAndPassword' | 'All') available for this user. |
| sshForwardingEnabled | Boolean | 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. |
| sshPublicKeys | Config2_SSHPublicKeyManager | An object that allows SSH public keys for this user to be managed. |
| sshTerminalEnabled | Boolean | 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 Config2_Site. |
| sshTerminalShell | String | Determines which type of console interface (shell) the user is placed into when they connect with SSH terminal. |
| twoFactorAuthEnabled | Boolean | Is two-factor authentication enabled for this user? . |
| type | String | The type of this user. |
| userName | String | The user-name of this user. |
Methods
| Method | Returns | Description |
|---|---|---|
| remove() | void | Deletes this user. |
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.
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.
Date and time when the user was created.
Type:
- Date
description :String
- Description:
The description of this user.
The description of this user.
Type:
- String
email :String
- Description:
A user's e-mail address may be used in e-mail notifications.
A user's e-mail address may be used in e-mail notifications.
Type:
- String
enabled :Boolean
- Description:
Is this user currently enabled?
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.
The user's expiry date. After this date the user cannot log in, which is useful for temporary users.
Type:
- Date
filesEncryptedAtRest :Boolean
- 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 Config2_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.
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 Config2_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.
Type:
- Boolean
ftpEnabled :Boolean
- Description:
Is the FTP protocol enabled for this user?
Is the FTP protocol enabled for this user?
Type:
- Boolean
ftpsEnabled :Boolean
- Description:
Is the FTPS protocol enabled for this user? If Config2_User.ftpEnabled is false and Config2_User.ftpsEnabled is true, then clients must connect using FTPS.
Is the FTPS protocol enabled for this user? If Config2_User.ftpEnabled is false and Config2_User.ftpsEnabled is true, then clients must connect using FTPS.
Type:
- Boolean
fullName :String
- Description:
The full name of this user.
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.
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?
Is the HTTP protocol enabled for this user?
Type:
- Boolean
httpsEnabled :Boolean
- Description:
Is the HTTPS protocol enabled for this user?
Is the HTTPS protocol enabled for this user?
Type:
- Boolean
(readonly) id :String
- Description:
The ID of this user.
The ID of this user.
Type:
- String
(readonly) inbuilt :Boolean
- Description:
Is this an inbuilt user who is created automatically during installation?
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 Config2_Site.jssEnabled).
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 Config2_Site.jssEnabled).
Type:
- Boolean
(readonly) modifiedTime :Date
- Description:
Date and time when the user was last modified.
Date and time when the user was last modified.
Type:
- Date
password :String
- Description:
The password of this user. Note that this property is not required for Windows users.
The password of this user. Note that this property is not required for Windows users.
Type:
- String
(readonly) passwordChangeTime :Date
- Description:
Date and time when the user's password was last changed.
Date and time when the user's password was last changed.
Type:
- Date
(readonly) passwordHash :String
- Description:
The hash of this user's password.
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.
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.
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.
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 upload, delete and rename files and folders.
If this flag is set then the user will be unable to upload, delete and rename files and folders.
Type:
- Boolean
reportDecryptedSize :Boolean
- Description:
Report decrypted file size for encrypted files.
Report decrypted file size for encrypted files.
Type:
- Boolean
scpEnabled :Boolean
- Description:
Is the SCP protocol enabled for this user?
Is the SCP protocol enabled for this user?
Type:
- Boolean
sftpEnabled :Boolean
- Description:
Is the SFTP protocol enabled for this user?
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 'PublicKey' | 'PublicKeyAndPassword' | 'All') available for this user. The SSH authentication methods are also specified at the site level (see 'PublicKey' | 'PublicKeyAndPassword' | 'All') available for this user. The SSH authentication methods are also specified at the site level (see Config2_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.