Create a User
Summary
Adds a new user to your site. Only site administrators can create a new user.
Endpoint
POST https://mysite.files.com/api/v2/users
Replace mysite.files.com with your site address.
Request Body Schema
| Name | Data Type | Notes |
|---|---|---|
username | string | Required. This should follow standard username conventions—spaces are not allowed, etc. |
nickname | string | The full name for the new user. |
homeResource | string | Required. 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:. |
email | string | Required. Must be a valid email address. |
password | string | Required. The password for the new user. Passwords cannot be set to common words or passwords which have been published on the dark web. |
role | string | Required. Send admin if the new user should be a site administrator, or user otherwise.Possible values: admin, user. |
permissions | object | An 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. |
timeZone | string | Required. 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. |
expiration | date-time | Optional 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. |
locked | boolean | If true, the user will account will be disabled. |
welcomeEmail | boolean | Legacy setting which is no longer used. |
onboarding | boolean | Legacy setting which is no longer used. |
Permissions Object
The permissions object included in the request schema has the following properties
| Name | Data Type |
|---|---|
list | boolean |
download | boolean |
upload | boolean |
modify | boolean |
delete | boolean |
changePassword | boolean |
share | boolean |
notification | boolean |
viewFormData | boolean |
deleteFormData | boolean |
undelete | boolean |
Get Instant Access to Files.com
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