Import Users in Bulk – Syntax and Definitions

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,
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