Update a User
Summary
Changes a user within your site. Only site administrators can update a user, and all site administrators can update every user account.
Users who are not site administrators cannot change their own user account settings with this API.
Endpoint
PATCH https://mysite.files.com/api/v2/users/{id}
Replace mysite.files.com with your site address.
Path Parameters
Parameter | Description |
---|---|
id | The internal user ID number, not the username. |
Request Body Schema
Any values you do not wish to change for the user can be left out of the request.
Name | Data Type | Notes |
---|---|---|
username | string | This should follow standard username conventions—spaces are not allowed, etc. |
nickname | string | The full name for the user. |
homeResource | string | 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 | Must be a valid email address. |
password | string | The new password for the user. Passwords cannot be set to common words or passwords which have been published on the dark web. |
role | string | Send admin if the 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. 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 account will be disabled. |
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 |