< All Topics

Import Users in Bulk – 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

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,
overrideIpWhitelist,ipWhitelistEnabled,ipWhitelist,overridePasswordPolicy,passwordPolicyEnabled,passwordPolicy,
overrideAccessWeb,accessWebEnum,ssoName,overrideAccessNonWeb,accessNonWebEnum,overridePasswordAuthentication,
passwordAuthenticationEnum,activeDirectoryName

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. 54.85.15.152, 54.85.16.0/24
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:
/ftp.api/accessWeb/none
/ftp.api/accessWeb/password
/ftp.api/accessWeb/sso
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:
/ftp.api/accessNonWeb/none
/ftp.api/accessNonWeb/password
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:
/ftp.api/passwordAuthentication/active_directory
/ftp.api/passwordAuthentication/native
activeDirectoryName Name of Active Directory configuration The name field that is visible to administrators on the /setup/active-directory/ page
Table of Contents