Import Users
The user import feature allows you to add multiple users at once by uploading a .csv file contain data for each of the user fields. This feature is useful if you plan to start with greater than 50 users. To begin, download the csv template file.
User Field Values
Fields should contain specific values. You can read more about user permissions.
Fields
Values
username
This field can't contain special characters and spaces. This field is required.
This is a valid email address used for notifications and when resetting passwords. This field is required.
password
Any characters can be used. This field is required.
nickname
This is a friendly label shown internally only. If left empty, value will be same as username.
home_folder
This is the starting directory for the user. If the folder does not already exist, it will be created when the user is created. If left empty, value will be the root folder / . Valid enclosed with “ path should be here.
send_welcome_email
Designate whether or not to send a welcome email when the user is created. If left empty, will have value 'FALSE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
enable_onboarding
Specify if the user should get introductory tips when first logging in to the account.
upload
Specify if the user is allowed to upload files and folders to the account. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
download
Specify if the user is allowed to download files and folders. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
delete
Specify if the user is allowed to delete files in the account. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
modify
Specify if the user is allowed to move, copy or rename files. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
list
Specify if the user is allowed to see the files and folders on the account. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
share
Specify if the user is allowed to use the sharing functions: send files, share folders, and create receive folders. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
send_notifications
Specify if the user is allowed to create notifications to send emails when a triggering event (upload, download) occurs. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
change_password
Specify if the user is allowed to reset the assigned password. If left empty, will have value 'TRUE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
view_form_data
Specify is the user to see the custom data associated with a receive folder. If left empty, will have value 'FALSE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
locked
Specify whether or not the user is blocked from logging in to the account. If left empty, will have value 'FALSE'. You can put 't' or 'f', 'true' or 'false', '0' or '1' here.
role
Specify whether the user is a regular user or should have administrative rights on the account. If left empty, the value will be 'user'. You can put 'user' or 'admin' here.
expiration_date_yyyy-mm-dd
Specify a future date when the user will be blocked from logging in to the account. If left empty value will be 'null'. Use date format year-month-day (i.e., 2019-01-31).
Adding Users to the CSV File
Download the starting .csv file here.
The fields must be listed in the following order to add users into the .csv files:
username,email,password,nickname,”home_folder“,send_welcome_email, enable_onboarding,role,upload,download,delete,modify,list,share, send_notifications,change_password,view_form_data,locked,expiration_date_yyyy-mm-dd
- THE FIRST THREE FIELDS ARE REQUIRED.
- All other fields are optional.
- Fields should be divided by ,
- Use one row per user and end the row without a comma delimiter.
- If home folder field is specified, it should be enclosed with ” .
IMPORTANT NOTES for Exporting .csv Files
- Excel escapes quotes with quotes when saving .csv file so you can get something like “”/homefolder“” and this will spoil the import process. In order to avoid this DO NOT add quotes as Excel will automatically add quotes for you.
- The user import tool does not accept files saved as “CSV UTF-8 (*.csv)”. If saving a .csv from MS Excel, make sure you select one of the following supported formats:
- CSV (Comma delimited) (*.csv)
- CSV (Macintosh) (*.csv)
- CSV (MS-DOS) (*.csv)
Importing Your CSV File
To import your user file:
1. Log in as the master user or as an admin user.
2. Click the Users button.
3. Click the IMPORT USERS button.
4. If you haven't already created your import .csv file, download the example file and complete the fields as specified above.
5. Click the CHOOSE CSV FILE button and select your completed .csv file for upload.
6. Click the IMPORT USERS button to process the file.
- You can only create (and not update) users with this file. If you need to make changes to existing users please do so through the web interface or programmatically with the ExaVault API.
- If the import tool encounters any errors (e.g. user already exists), it will skip the user in question and try to create the remaining users.
Table Of Contents
Support Library
Still Have Questions?
Email Us
Don't see the answer you need? Drop us a note, and our support team will email you back.
Send Email
