| Username |
string |
Username of the user to create. This should follow standard username conventions; e.g. all lowercase, no spaces, etc. We do allow email addresses as usernames. |
[optional] [default to null] |
| Nickname |
string |
An optional nickname (e.g. 'David from Sales'). |
[optional] [default to null] |
| DestinationFolder |
string |
The path to the user's home folder. For the account root, specify `/`. Otherwise, use standard Unix path format, e.g. `/path/to/some/dir`. The user will be locked to this directory and unable to move 'up' in the account. If the folder does not exist in the account, it will be created. Note that users with the role `admin` cannot have a folder other than `/`. |
[optional] [default to null] |
| Email |
string |
The user's email address. |
[optional] [default to null] |
| Password |
string |
The user's password. |
[optional] [default to null] |
| Role |
string |
The user's role. Note that admin users cannot have a `destinationFolder` other than `/`, and will be setup with full permissions regardless of what you specify in the `permissions` property. |
[optional] [default to null] |
| Permissions |
string |
A CSV string of user permissions. For example: `upload,download,list`. Note that users will be unable to see any files in the account unless you include `list` permission. |
[optional] [default to null] |
| TimeZone |
string |
The user's timezone, used for accurate time display within the application. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values. |
[optional] [default to null] |
| Expiration |
string |
Optional timestamp when the user should expire, formatted in ISO 8601. |
[optional] [default to null] |
| Locked |
bool |
If true, the user's account is locked by default. Locked users cannot log in. |
[optional] [default to false] |
| Onboarding |
bool |
If `true`, enable extra help popups in the web application for this user. |
[optional] [default to false] |