Single-tenant import

Importing user syntax and definitions

The import function streamlines and facilitates the setting up of multiple users. This will allow you to easily set up hundreds of users using a simple process.  Our best practice is to use a spreadsheet to create the import users list and then convert to a CSV file to paste into the import window, this will also ensure that you have a record of all the users and import data.

Format your import with comma separated fields and ensure that the first line contains the descriptor as noted below with the fields you require. This should be followed by one or more lines per user that you want to import.

Full user import syntax descriptor

You can import a user and manage their settings by filling in all the fields below. If you do not require to fill in a specific field, you can remove the field name in the syntax below.

@add_user=username,password,name,storageQuota,bandwidthQuota,shared_user,readOnly,timeZoneEnum, countryEnum,languageEnum,groupName,defaultFtpPath,notifyReceive,notifySend,email,pki,admin,overrideFtps,ftps,

CSV Templates

Example User Import Template

Empty User Import Syntax Template

Example user import syntax

The following user import example specifies having a username called FTPUser with a password set as p456uber, 0GB storage quota, being a managed user, with full access to upload and download files, with a country setting in the United Kingdom, and a default folder to land in called “Submitted”. Note that the other fields have been deleted.

  • @add_user=username,password,storageQuota,shared_user,readOnly,countryEnum,defaultFtpPath
  • FTPUser,p456uber,0,true,false,UK,Submitted

The next example user import specifies having a name called 123User with a password set to 123456, 40GB storage, being a non-managed user, with read-only access to only download files, with timezone in New York, and in a group called “Accounting”. Note that the other fields have been deleted.

  • @add_user=username,password,storageQuota,shared_user,readOnly,timeZoneEnum,groupName
  • 123User,123456,400000000000,false,true,AmericaXNew_York,Accounting

User Import Syntax Definitions

Import field Description Value/Example
username FTP/SFTP username for logging into the Hosted~FTP~ service See this link for username policy
e.g. Co_username1
password Password associated with the username Minimum of 6 characters
e.g. 123456
Please see this link for our password policy.
name Name assigned to the user, if not assigned the name field will populate with the username Name of the user

e.g. Outbound-Sales

storageQuota Assigns a storage quota to the user,  if not assigned user will have access to all account resources. If looking for a restricted folder share outcome the recommendation is to set a 0GB quota. Number of bytes with no delimiters
e.g. 1000000000 (=1GB)
bandwidthQuota Assigns bandwidth quota which will control how much this user can upload/download. Number of bytes with no delimiters

e.g. 1000000000 (=1GB)

shared_user Indicates if the user is a “Managed user” which removes the Setup tab from their account login page and disables password resets allowing the admin to manage both settings and passwords. True: sets user to be managed by the admin


False: user can manage their own setup options.

readOnly Sets the user to “read-only” which allows the user to download but not upload True: User set as a “download only” user


False: User permissions set to Full which allows user upload and download depending on their folder privileges

timeZoneEnum Sets the Users timezone Click here for a list of Java timezone IDs.

The value should be the standard Java timezone ID but the forward slash (/) is replaced by “X”.

e.g. The Java timezone ID for Los Angeles is: America/Los_angeles Instead, enter AmericaXLos_Angeles


countryEnum Sets the users country and geographic area Click here for a list of Country IDs.

Standard 2 letter country abbreviation

e.g. US, CA, GB, AE, IN, HK, etc.

languageEnum Sets the language preference for the user Any of the following values in lower case.

e.g. browser, en, fr, de, it, es, pl.

groupName The administrator or Group admin can assign the user to an existing group The name of an existing group in the account
e.g. marketingteam
defaultFtpPath Sets the folder the user starts in upon logging in. Name of any folder in the user’s account.
e.g. folder1/subfolder21 (without “/” in the beginning)
notifyReceive  Sets the user to be notified when files are received  True or False
notifySend  Sets the user to be notified when files are successfully sent  True or False
pki Public key for SFTP public key authentication Public key component of an RSA keypair
admin Sets the user to be an operational admin True or False
overrideFtps Override account or group level setting for “Force only secure protocols for this user” True or False
ftps User level setting for “Force only secure protocols for this user” True or False
overrideIpWhitelist Override account or group level setting for IP whitelist True or False
ipWhitelistEnabled User level setting for whether an IP whitelist is enabled or disabled True or False
ipWhitelist List of IP address or CIDR ranges separated by commas or spaces e.g.,
overridePasswordPolicy Override account or group level setting for password policy True or False
passwordPolicyEnabled User level setting for whether password policy is enabled or disabled True or False
passwordPolicy Textual representation of a password policy Link to additional detail
overrideAccessWeb Override account or group level setting for “Web (https) logins for this user” True or False
accessWebEnum User level setting for “Web (https) logins for this user” Possible values include:
ssoName Name of SSO configuration The name field that is visible to administrators on the /setup/sso page
overrideAccessNonWeb Override account or group level setting for “Non-web (ftp/ftps/sftp) logins for this user” True or False
accessNonWebEnum User level setting for “Non-web (ftp/ftps/sftp) logins for this user” Possible values include:
overridePasswordAuthentication Override account or group level setting for “Authenticate passwords for this user with” True or False
passwordAuthenticationEnum User level setting for “Authenticate passwords for this user with” Possible values include:
activeDirectoryName Name of Active Directory configuration The name field that is visible to administrators on the /setup/active-directory/ page
email FTP/SFTP email address for logging into the Hosted~FTP~ service and for email notifications Any valid email address. This field is not available on the Hosted~FTP~ multi-tenant service because all email addresses must be verified before they can be associated with a user account. This field is available to single tenant services only.
homeFolderEnabled User is locked to this shared folder as root and cannot navigate to other shared folders, can access subfolders under this shared folder True or False

This field is not available on the Hosted~FTP~ multi-tenant service. This field is available to single tenant services only.

homeFolder (replaces defaultFtpPath) *This feature is available upon request by contacting

The name of any folder that the user has access to.
Getting Started
Signing up for a Free Trial
Basic steps to Setup
Purchasing your account
Choosing the right account type: Enterprise and SMB
Logging into your account
How to login with a Web Browser
How to Login to an FTP client via FTP
How to Login to an FTP Client via SFTP
Logging in by FTP URL with Username and Password
Reset and change your password
How to Update an Expired Password
Administrator Initial Setup
Account-level options
Force Secure Protocols only (FTPS/HTTPS/SFTP)
Enabling a Password Policy
Enabling CJIS Compliance Policy
Add IP whitelisting
Configuring Web Access
Configuring FTP/SFTP Access
Implementing Multiple Administrators
Adding branding to your account
Branding Contact Logins
Creating a Custom Subdomain (
Web Interface
Home Tab
Files Tab
Contacts Tab
Users Tab
Plugin Tab
Setup Tab
Adding a User or Contact
Adding a Contact by Email Address
Add a User by Email Address
Add a User by Username
Using Groups
Account setup PDF Guides (*.pdf)
Activated Account Limits
Shared Folders
Configuring for Restricted Shared Folders (FUSN)
Creating Folder Structures for Sharing
Detailed Steps to Sharing Files/Folders
Managing Shared Folder Privileges
Add real-time notifications to uploads/downloads
Audit logs and Real-time Reports
Using Real-time Reports
Example Report Filters
More Example Report Filters
Exporting a Report
Enable audit logs for logins, file transfers, and deletes
Accessing and viewing your audit logs
Steps to sharing the logs folder
Anonymous Access
Creating A Public Link
Anonymously Sharing Files and Folders
Transferring Files
Uploading Files by Web Browser
Uploading Files by FTP Client
Download your FTP/SFTP server files from any browser
Download files with an FTP client
Using the Send function to securely send files through a web-based link
Using the Send function from your Files tab
Managing Mail Events (Send and Receive function)
Drag & Drop
Uploading Multiple Files with Drag and Drop
Enabling Drag & Drop on Legacy IE Browsers
Website Plugin
Integrating the Upload Plugin into your Website and Business
Web Plugin Overview and Guide
Plugin Brand Customization
Embed the Plugin into Your Website
Adding Additional Security (CAPTCHA, Password)
Security and Compliance Info
Security Model Overview
Security Model Details
Multi-Factor Authentication
MFA Initial setup for a standard user by Admin
MFA by User (Multi-Factor Authentication)
MFA reset on managed user
MFA reset on a standard user
Configuring Single Sign-On (SSO) for your account
Configuring Okta with OpenID
Configuring AzureAD with OpenID
Enabling Single Sign-On (SSO) for user logins
Certificate & Host Key Info
SSL Certificate Info
Trusting the Hosted~FTP~ SSL Certificate
SSL Server Test
FTPS Host Keys
SFTP (RSA/DSA) Host Keys
Configuring PKI Support
Compliance Info
WCAG 2.0
Bundle Features
Hosted~FTP~ vs. AWS Transfer Family
Group vs. Enterprise bundle features
Enterprise T1 vs. T2 Bundle Comparison
Enterprise T2 Plan Features
Different user types and function comparisons
Difference between users and contacts
Sync Feature
Configuring a Sync to SFTP Gateway
Configuring a Sync to S3 Gateway
Regular expressions with Sync feature
File Retention Policy
Configuring a File Retention Policy
File Retention Policy Examples
Account Management
Purchasing your account
Payments & Billing
Choosing a payment plan
Renewing an expired account
Changing a Bundle or Payment Plan
Changing Credit Card Information
Reviewing billing statements
Trial Account Limits
How is Storage Calculated?
Reviewing account resources and usage
Switching Account Bundles
Changing the Account Administrator
Administrator Access to User Accounts
Cancelling an Account
FTP/FTPS/SFTP Connections
Hosted~FTP~ IP Addresses
SFTP (RSA/DSA) Host Keys
Connect with Plain FTP
Connect with Secure FTPS/SFTP
Connecting with an FTP Client
Command Line (CLI)
How to connect to your remote site using the command line
How to login to SFTP with one line on Linux
Understanding FTP commands in the command line
Connecting through SFTP by Command Line (CMD)
Using PKI keys to connect to Hosted~FTP~ on linux
Importing PuttyGen PKI Keys to Linux
FTP/FTPeS command line error codes and their meaning
Windows Network Locations
Add Network Location Windows XP
Add Network Location Windows 10/8/7
Connecting from a Mac Computer Terminal
Using Filezilla with FTP/FTPS
Using FileZilla with SFTP
Connecting to WebDrive
Using WebDrive
Installing WinSCP
Uploading & Downloading with WinSCP
WinSCP Scripting
Executing WINSCP script from a saved site
Executing WINSCP script without a saved site
Transfer new and updated files only
Backup Scripts with WinSCP
Keep Folders up to date
Uploading & Downloading with AndFTP
Searching, Resume Support & Third-party Sharing with AndFTP
FTP, SFTP Use Cases in Industries
EDI document transfers
Integrating the Upload Plugin into your Website and Business
Real Estate
Call Center
Best Practices
Use Cases
Exporting EDI files to FTP for download
User Optimization
Create a Managed User
Giving a User Read-only Access
Giving a User Full Access
Default FTP Folder Destination
Set a 0GB Storage Quota
Deleting a User and Keeping their Files
Importing Multiple Users & Shared Folders
Importing Users in Bulk – Syntax and Definitions
Importing Restricted Shared Folders in Bulk – Syntax and Definitions
Detailed Steps and Example Templates for Importing
Exporting a User List
Combine multiple audit logs
Managing FTP Files and Storage in your Account
Moving Files from a User to an Administrator
Video Tutorials
Web Interface
Home Tab
Files Tab
Web Plugin
AndFTP – Connecting, uploading and downloading
AndFTP – Searching, resume support and third-party sharing
WinSCP – Downloading, Installing and Understanding
WinSCP – Connecting with FTP, FTPS, SFTP, uploading and downloading
WinSCP Backup Script
Cyberduck– Connecting with FTP,FTPS, SFTP, Uploading and Downloading
Cyberduck– Quick Look, Transfer Queue and Synchronizing
Cyberduck – Bookmarks, Editing and using Multiple Connections
FileZilla -Downloading, Installing and Understanding FileZilla
FileZilla – Connecting with FTP, FTPS, SFTP and uploading and downloading
FileZilla – Importing/Exporting Site Connections, Editing and Logs
FileZilla Tools – Bookmarking, Searching, using Multiple Connections
Our FTP Client Reviews
Desktop FTP Client Summary
Mobile FTP Client Summary
PSFTP Review : Our Rating 7.5/10
NetDrive Review: Our Rating 8.5/10
Filezilla Review: Our Rating 9/10
AndFTP Review:Our Rating 7.8/10
ES File Manager Review: Our Rating 5/10
FTP Ready Review:Our Rating 5/10
FTP On The Go Review:Our Rating 8/10
CyberDuck Review: Our Rating 9/10
Classic FTP Review: Our Rating 8/10
WebDrive Review: Our Rating 9.5/10
Fling FTP Review: Our Rating 9/10
SmartFTP Review: Our Rating 7/10
MultCloud Review: Our Rating 10/10
Hosted~FTP~ Quota Messages and Definitions
FTP/FTPeS command line error codes and their meaning
Troubleshooting FTP in the command line and common errors.
No matching host key found
Storage Quota Notification: Remedial action
Troubleshooting FTP in the command line and common errors.
Troubleshooting “Can’t verify publisher”
Troubleshooting Drag and Drop
Drag and Drop Troubleshooting for Mac
Troubleshooting FTP/SFTP client connection problems
Troubleshooting slow upload speeds on Windows
No matching host key found
File not visible to admin
File uploaded successfully but not visible in account
Usernames – Guidelines and Restrictions
Download Center
Contact Sales & Support
Joining GoToMeeting by Browser
Joining GoToMeeting by Client