Update account settings, such as welcome email content, IP address restrictions, webhooks settings and secure password requirements.
Notes
- You must have to change account settings.
643 matches
49 actions
ExaVault
49 actions
- Complete send filesPOSTv1.0.0
- Compress resourcesPOSTv1.0.0
- Copy resourcesPOSTv1.0.0
- Create a folderPOSTv1.0.0
- Create a new notificationPOSTv1.0.0
- Create a new SSH KeyPOSTv1.0.0
- Create a userPOSTv1.0.0
- Create new email listPOSTv1.0.0
- Creates a sharePOSTv1.0.0
- Deactivate a shareDELETEv1.0.0
- Delete a notificationDELETEv1.0.0
- Delete a receive form submissionDELETEv1.0.0
- Delete a ResourceDELETEv1.0.0
- Delete a userDELETEv1.0.0
- Delete an email group with given idDELETEv1.0.0
- Delete an SSH KeyDELETEv1.0.0
- Delete ResourcesDELETEv1.0.0
- Extract resourcesPOSTv1.0.0
- Get a list of all resourcesGETv1.0.0
- Get a list of notificationsGETv1.0.0
- Get a list of sharesGETv1.0.0
- Get a list of usersGETv1.0.0
- Get a shareGETv1.0.0
- Get account settingsGETv1.0.0
- Get activity logsGETv1.0.0
- Get all email groupsGETv1.0.0
- Get form data entries for a receiveGETv1.0.0
- Get individual email groupGETv1.0.0
- Get info for a userGETv1.0.0
- Get metadata for a list of SSH KeysGETv1.0.0
- Get metadata for an SSH KeyGETv1.0.0
- Get notification detailsGETv1.0.0
- Get receive folder form by IdGETv1.0.0
- Get receive folder form settingsGETv1.0.0
- Get resource metadataGETv1.0.0
- Get Resource PropertiesGETv1.0.0
- List contents of folderGETv1.0.0
- Move resourcesPOSTv1.0.0
- Preview a fileGETv1.0.0
- Rename a resource.PATCHv1.0.0
- Resend invitations to share recipientsPOSTv1.0.0
- Resend welcome email to specific userPOSTv1.0.0
- Send referral email to a given addressPOSTv1.0.0
- Update a notificationPATCHv1.0.0
- Update a sharePATCHv1.0.0
- Update a userPATCHv1.0.0
- Update account settingsPATCHv1.0.0
- Update an email groupPATCHv1.0.0
- Updates a form with given parametersPATCHv1.0.0
Storage/ExaVault
Update account settings
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
{
"type": "object",
"properties": {
"accountOnboarding": {
"type": "boolean",
"description": "Whether extra help popups can be enabled for users in the web file manager."
},
"allowedIpRanges": {
"type": "array",
"description": "IP Address Ranges for restricting account access",
"items": {
"type": "object",
"properties": {
"ipEnd": {
"type": "string",
"format": "ipv4"
},
"ipStart": {
"type": "string",
"format": "ipv4"
}
}
}
},
"brandingSettings": {
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "Custom company name to include in copyright and title bar."
},
"customEmail": {
"type": "string",
"format": "email",
"description": "Address to use as sender of email messages generated by ExaVault"
},
"theme": {
"type": "string",
"description": "Color scheme for web file manager. Valid options are **default**, **light** and **dark**"
}
}
},
"complexPasswords": {
"type": "boolean",
"description": "Whether to require complex passwords for all passwords."
},
"customSignature": {
"type": "string",
"description": "Signature to be automatically added to the bottom of emails generated by the account."
},
"emailContent": {
"type": "string",
"description": "Content of welcome email template."
},
"emailSubject": {
"type": "string",
"description": "Subject line for welcome emails"
},
"ev-access-token": {
"type": "string"
},
"ev-api-key": {
"type": "string"
},
"externalDomain": {
"type": "string",
"description": "Custom address used for web file manager. Not available for all account types."
},
"quota": {
"type": "object",
"properties": {
"noticeEnabled": {
"type": "boolean",
"description": "Whether the system should email the account owner if the account storage exceeds the noticeThreshold value. Storage notice emails are sent no mo once per day."
},
"noticeThreshold": {
"type": "integer",
"description": "Percent of account storage that would trigger a notice email. Must be a whole number between 70 and 100 (inclusive)."
},
"transactionsNoticeEnabled": {
"type": "boolean",
"description": "Whether the system should email the account owner if the daily transaction usage exceeds the transactionsNoticeThreshold value. Transaction notice emails are sent no more than once per day."
},
"transactionsNoticeThreshold": {
"type": "integer",
"description": "Percent of daily transaction usage that would trigger a notice email. Must be a whole number between 70 and 100 (inclusive)."
}
}
},
"secureOnly": {
"type": "boolean",
"description": "Whether unencrypted FTP connections should be denied for the account."
},
"showReferralLinks": {
"type": "boolean",
"description": "Whether to display links for others to sign up on share views and invitation emails"
}
},
"required": [
"ev-access-token",
"ev-api-key"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
- 463
- 464
- 465
- 466
- 467
- 468
- 469
- 470
- 471
- 472
- 473
- 474
- 475
- 476
- 477
- 478
- 479
- 480
- 481
- 482
- 483
- 484
- 485
- 486
- 487
- 488
- 489
- 490
- 491
- 492
- 493
- 494
- 495
- 496
- 497
- 498
- 499
- 500
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
- 512
- 513
- 514
- 515
- 516
- 517
- 518
- 519
- 520
- 521
- 522
{
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Object contains all account properties.",
"properties": {
"attributes": {
"type": "object",
"properties": {
"accountName": {
"type": "string",
"description": "Name of the account"
},
"accountOnboarding": {
"type": "boolean",
"description": "Whether the web application onboarding help is enabled for new users in the account."
},
"allowedIp": {
"type": "array",
"description": "Range of IP addresses allowed to access this account.",
"items": {
"type": "object",
"properties": {
"ipEnd": {
"type": "string"
},
"ipStart": {
"type": "string"
}
}
}
},
"branding": {
"type": "boolean",
"description": "Branding flag. Set to `true` if the account has branding functionality enabled.",
"enum": [
true,
false
]
},
"brandingSettings": {
"type": "object",
"properties": {
"companyName": {
"type": "string"
},
"customEmail": {
"type": "string",
"format": "email"
},
"logo": {
"type": "string"
},
"logoExt": {
"type": "string"
},
"theme": {
"type": "string"
},
"verifiedDomain": {
"type": "string"
},
"verifiedDomainId": {
"type": "string"
},
"verifiedDomainValid": {
"type": "boolean"
}
}
},
"clientId": {
"type": "integer",
"format": "int32",
"description": "(ExaVault Use Only) Internal ID of the account in CMS."
},
"complexPasswords": {
"type": "boolean",
"description": "Flag to indicate whether the account requires complex passwords. Set to `true` to require complex passwords on all users and shares."
},
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of account creation."
},
"customDomain": {
"type": "boolean",
"description": "Custom domain flag. Set to `true` if account type allows custom domain functionality.",
"enum": [
true,
false
]
},
"customSignature": {
"type": "string",
"description": "Custom signature for all account emails users or recipients will receive."
},
"externalDomains": {
"type": "array",
"description": "Custom domain used to brand this account.",
"items": {
"type": "string"
}
},
"maxUsers": {
"type": "integer",
"format": "int32",
"description": "Maximum number of users the account can have. This can be increased by contacting ExaVault Support."
},
"modified": {
"type": "string",
"format": "date-time",
"description": "Timestamp of account modification."
},
"planDetails": {
"type": "object",
"properties": {
"apiKeys": {
"type": "integer"
},
"apiTokens": {
"type": "integer"
},
"colorSchema": {
"type": "boolean"
},
"customDomain": {
"type": "boolean"
},
"customName": {
"type": "boolean"
},
"directLinks": {
"type": "boolean"
},
"ipWhitelist": {
"type": "boolean"
},
"sharingOptions": {
"type": "array",
"items": {
"type": "string"
}
},
"sshKeys": {
"type": "integer"
},
"storageAddOn": {
"type": "integer"
},
"unlimitedUsers": {
"type": "boolean"
},
"userExpiration": {
"type": "boolean"
},
"userImport": {
"type": "boolean"
},
"webhookOptions": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"includeTriggers": {
"type": "string"
},
"restrictionTypes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"quota": {
"type": "object",
"properties": {
"bandwidthLimit": {
"type": "integer",
"format": "int64",
"description": "Total number of bytes that can be transferred per month."
},
"bandwidthUsed": {
"type": "integer",
"format": "int64",
"description": "Number of bytes transferred this month."
},
"diskLimit": {
"type": "integer",
"format": "int64",
"description": "Amount of disk space that the account has available to it. This may be increased by upgrading to a larger plan."
},
"diskUsed": {
"type": "integer",
"format": "int64",
"description": "Amount of disk space currently in use."
},
"noticeEnabled": {
"type": "boolean",
"description": "Should a quota warning be sent to the account owner when a threshold level of space utilization is reached?"
},
"noticeThreshold": {
"type": "integer",
"format": "int32",
"description": "Treshold that triggers a quota notification. This represents the \"percent full\" your account must be before the quota notification is generated."
},
"transactionsLimit": {
"type": "integer",
"format": "int32",
"description": "Total number of transactions allowed in a 24-hour period."
},
"transactionsNoticeEnabled": {
"type": "boolean",
"description": "Whether an email should be sent to the account owner up to once per day if transaction usage exceeds `transactionsNoticeThreshold` value."
},
"transactionsNoticeThreshold": {
"type": "integer",
"format": "int32",
"description": "Percent of daily transactions limit that will trigger an email if activity exceeds it."
}
}
},
"secureOnly": {
"type": "boolean",
"description": "Flag to indicate whether the account disables connections via insecure protocols (e.g. FTP). Set to `true` to disable all traffic over port 21."
},
"showReferralLinks": {
"type": "boolean",
"description": "Flag to indicate showing of referrals links in the account. Set to `true` to include marketing messages in share invitations."
},
"status": {
"type": "integer",
"format": "int32",
"description": "Account status flag. A one (1) means the account is active; zero (0) means it is suspended.",
"enum": [
1,
0
]
},
"userCount": {
"type": "integer",
"format": "int32",
"description": "Current number of users on the account."
},
"welcomeEmailContent": {
"type": "string",
"description": "Content of welcome email each new user will receive."
},
"welcomeEmailSubject": {
"type": "string",
"description": "Subject of welcome email each new user will receive."
}
}
},
"id": {
"type": "integer",
"format": "int32",
"description": "Account ID"
},
"relationships": {
"type": "object",
"properties": {
"masterUser": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of master user for account"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
}
}
}
}
}
},
"type": {
"type": "string",
"description": "Type of item. \"account\"",
"enum": [
"account"
]
}
}
},
"included": {
"type": "array",
"description": "Array can contain objects specified in include param of the get call e.g User object",
"items": {
"type": "object",
"description": "Object contains user properties.",
"properties": {
"attributes": {
"type": "object",
"description": "Attributes of the user including expiration, home directory, and permissions. ",
"required": [
"status",
"created",
"modified",
"accountName",
"username",
"nickname",
"homeResource",
"permissions",
"role",
"timeZone",
"onboarding"
],
"properties": {
"accessTimestamp": {
"type": "string",
"description": "Timestamp of most recent successful user login."
},
"accountName": {
"type": "string",
"description": "Name of the account this user belongs to."
},
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of user creation."
},
"email": {
"type": "string",
"description": "Email address of the user."
},
"expiration": {
"type": "string",
"description": "Timestamp of user expiration."
},
"firstLogin": {
"type": "boolean",
"description": "`true` if the user has logged into the system."
},
"homePath": {
"type": "string",
"description": "Path to the user's home folder."
},
"locked": {
"type": "boolean",
"description": "`true` if the user is locked and cannot log in."
},
"modified": {
"type": "string",
"format": "date-time",
"description": "Timestamp of user modification."
},
"nickname": {
"type": "string",
"description": "Nickname of the user."
},
"onboarding": {
"type": "boolean",
"description": "Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user."
},
"permissions": {
"type": "object",
"required": [
"download",
"upload",
"modify",
"delete",
"list",
"changePassword",
"share",
"notification",
"viewFormData",
"deleteFormData"
],
"properties": {
"changePassword": {
"type": "boolean",
"description": "Change (own) password permission flag"
},
"delete": {
"type": "boolean",
"description": "Delete permission flag"
},
"deleteFormData": {
"type": "boolean",
"description": "Delete form data permission flag. If true, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded."
},
"download": {
"type": "boolean",
"description": "Download permission flag"
},
"list": {
"type": "boolean",
"description": "View folder contents permission flag"
},
"modify": {
"type": "boolean",
"description": "Modify permission flag"
},
"notification": {
"type": "boolean",
"description": "Notifications permission flag"
},
"share": {
"type": "boolean",
"description": "Sharing permission flag"
},
"upload": {
"type": "boolean",
"description": "Upload permission flag"
},
"viewFormData": {
"type": "boolean",
"description": "Access Form Data permission flag. If true, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form."
}
}
},
"role": {
"type": "string",
"description": "User's access level",
"enum": [
"user",
"admin",
"master"
]
},
"status": {
"type": "integer",
"format": "int32",
"description": "Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.",
"enum": [
0,
1
]
},
"timeZone": {
"type": "string",
"description": "User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values."
},
"username": {
"type": "string",
"description": "Username of the user."
}
}
},
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the user."
},
"relationships": {
"type": "object",
"description": "Home resource and owner account relationship data for the user. ",
"required": [
"ownerAccount"
],
"properties": {
"homeResource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "ID of home directory resource."
},
"type": {
"type": "string",
"description": "Type is resource.",
"enum": [
"resource"
]
}
}
}
}
},
"ownerAccount": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the account."
},
"type": {
"type": "string",
"description": "Type is account.",
"enum": [
"account"
]
}
}
}
}
}
}
},
"type": {
"type": "string",
"description": "Type of object being returned. Always \"user\""
}
}
}
},
"responseStatus": {
"type": "integer"
}
}
}