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/v1.2/createUser
Replace mysite.files.com with your site address.
Request Body Schema
| Name | Data Type | Notes |
|---|---|---|
access_token | string | Required. The session key that identifies which user is authenticated. Either an access token returned by the authenticateUser function, or a a Files.com user API Key. |
username | string | Required. Username of user to be created. This should follow standard username conventions—spaces are not allowed, etc. |
nickname | string | The full name for the new user. |
destinationFolder | string | Required. A path that the user will be given permission to. Users who will be site administrators should have a destinationFolder of / The path that is provided here will be used as the user_root for FTP. |
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 | string | Required. A CSV string of ExaVault-style user permissions, which will be translated into Files.com-style privileges. For example: specifiying upload,download,list will create a read/write user. |
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. |