Create a User


Adds a new user to your site. Only site administrators can create a new user.



Replace with your site address.

Request Body Schema

NameData TypeNotes
usernamestring Required. This should follow standard username conventions - spaces are not allowed, etc.
nicknamestringThe full name for the new user.
homeResourcestringRequired. A path that the user will be given permission to. Users who will be site administrators should have a homeResource of "/" The path that is provided here will be used as the user_root for FTP.
This can be specified as a file path (such as "/path/to/folder") or as an ID string (such as "id:1223"); if you are providing an ID string, it must start with "id:".
emailstringRequired. Must be a valid email address.
passwordstringRequired. The password for the new user. Passwords cannot be set to common words or passwords which have been published on the dark web.
rolestringRequired. Send "admin" if the new user should be a site administrator, or "user" otherwise.
Possible values: admin, user.
permissionsobjectAn object containing name/value pairs for each permission. Any permission that is not passed will be set to false by default. If an empty object is provided, it will create a user with no permissions.
When creating an admin user, you should set all of the permissions to true.
timeZonestringRequired. Time zone, used for accurate time display within the application.
Must be one of the allowed time zone identifiers.
"UTC" is not a valid option.
expirationdate-timeOptional timestamp when the user should expire.
Format is "YYYY-mm-dd HH:MM:SS".
Must be in the future; you cannot retroactively expire a user account.
lockedbooleanIf true, the user will account will be disabled.
welcomeEmailbooleanLegacy setting which is no longer used.
onboardingbooleanLegacy setting which is no longer used.

Permission Object

The permission object included in the request schema has the following properties

NameData Type

Get Instant Access to

The button below will take you to our Free Trial signup page. Click on the white "Start My Free Trial" button, then fill out the short form on the next page. Your account will be activated instantly. You can dive in and start yourself or let us help. The choice is yours.

Start My Free Trial

©2024 All right reserved


  • Start My Free Trial
  • Pricing
  • Docs
  • API and SDKs
  • Contact


(800) 286-8372


9am–8pm Eastern