Sign in

v1

latestOpenAPI 3.0.02026-07-135965404.0 KB
Users

Create a user

Adds a new user to the account. The user may be configured as an admin or standard user, and (if a standard user) may be assigned a restricted home directory and restricted permissions.

Notes:

  • You must be an admin-level user to use this.
post/users

Headers

ev-api-keystring required

API key required to make the API call

ev-access-tokenstring required

Access token required to make the API call.

Request body

usernamestring required

Username of the user to create. 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 required

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 is created.

Users with the role admin should have their homeResource set to '/'

emailstring email required

Email address for the user

passwordstring required

Password for the user

role'user' | 'admin' required

The type of user to create, either user or admin.

timeZonestring required

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, formatted in date-time.

lockedboolean

If true, the user will not be able to log in

welcomeEmailboolean

If true, send this new user a welcome email upon creation. The content of the welcome email can be configured with the PATCH /accounts method.

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",
  "permissions": {
    "list": true,
    "download": true,
    "upload": true,
    "modify": true,
    "delete": true,
    "changePassword": true,
    "share": true,
    "notification": true,
    "viewFormData": true,
    "deleteFormData": true
  },
  "timeZone": "America/Los_Angeles",
  "expiration": "2011-03-21 00:18:56",
  "locked": true,
  "welcomeEmail": true,
  "onboarding": true
}

Response

Successful Operation

responseStatusinteger

Http code for the response.