Sign in

v1

latestOpenAPI 3.0.02026-07-135965404.0 KB
Users

Update a user

Updates the settings for the user. Note that the unique key for this API call is our internal ID, and not the username, as the username can be changed.

In the request body, you should only send the parameters for values that you wish to change for the user.

Notes:

  • You must have admin or master access to edit other users. If you have user-level access, you can only update your own user settings.
  • You cannot edit a master user with this method.
patch/users/{id}

Headers

ev-api-keystring required
Example:exampleaccount-zwSuWUZ8S38h33qPS8v0s

API key required to make the API call.

ev-access-tokenstring required
Example:19853ef63a0bc348024a9e4cfd4a92520d2dfd04e88d8679fb1ed6bc551593d1

Access token required to make the API call.

Request body

usernamestring

New username for the user. This should follow standard username conventions - spaces are not allowed, etc. We do allow email addresses as usernames.

Note Usernames must be unique across all ExaVault accounts.

nicknamestring

An optional nickname (e.g. 'David from Sales').

homeResourcestring

Resource identifier for the user's home folder. See details on how to specify resources above.

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 when the user logs in.

This setting is ignored for users with the role admin.

emailstring email

Email address for the user

passwordstring

New password for the user

role'user' | 'admin'

The type of user (admin or user). Note that admin users cannot have a homeResource other than '/', and will have full permissions, but you must provide at least "download,upload,list,delete" in the permissions parameter.

timeZonestring

Time zone, 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.

expirationstring

Optional timestamp when the user should expire.

lockedboolean

If true, the user will be prevented from logging in

onboardingboolean

Set this to true to enable extra help popups in the web file manager for this user.

Example request

{
  "username": "testuser",
  "nickname": "testnickname",
  "homeResource": "/",
  "email": "testuser@example.com",
  "role": "user",
  "timeZone": "America/Los_Angeles",
  "expiration": "2011-03-21 00:18:56",
  "locked": true,
  "onboarding": true
}

Response

Successful Operation

responseStatusinteger

Http code for the response.