Update a User
Changes a user within your site. Only site administrators can update a user, and all site administrators can update every user account.
POST https://mysite.files.com/v1.2/updateUser
Replace mysite.files.com with your site address.
Any values you do not wish to change for the user can be left out of the request.
| 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. |
| userId | integer | Required. The user's internal ID number, not their login name. |
| username | string | This should follow standard username conventions - spaces are not allowed, etc. |
| nickname | string | The full name for the user. |
| destinationFolder | string | 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. |
| 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 | A CSV string of ExaVault-style user permissions, which will be translated into Files.com-style privileges. For example: "upload,download,list" permissions results in a read/write user. Updating a user's permissions will replace all permissions already defined for that user. |
| timeZone | string | 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. |
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