files.com 1.0.188 → 1.0.191
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/Errors.md +186 -0
- package/docs/models/AccountLineItem.md +53 -0
- package/docs/models/Action.md +37 -0
- package/docs/models/ActionNotificationExport.md +82 -0
- package/docs/models/ActionNotificationExportResult.md +49 -0
- package/docs/models/ActionWebhookFailure.md +16 -0
- package/docs/models/ApiKey.md +183 -0
- package/docs/models/App.md +66 -0
- package/docs/models/As2IncomingMessage.md +104 -0
- package/docs/models/As2OutgoingMessage.md +96 -0
- package/docs/models/As2Partner.md +141 -0
- package/docs/models/As2Station.md +142 -0
- package/docs/models/Auto.md +11 -0
- package/docs/models/Automation.md +257 -0
- package/docs/models/AutomationRun.md +61 -0
- package/docs/models/BandwidthSnapshot.md +50 -0
- package/docs/models/Behavior.md +195 -0
- package/docs/models/Bundle.md +330 -0
- package/docs/models/BundleDownload.md +44 -0
- package/docs/models/BundleRecipient.md +76 -0
- package/docs/models/BundleRegistration.md +53 -0
- package/docs/models/Clickwrap.md +120 -0
- package/docs/models/DnsRecord.md +33 -0
- package/docs/models/Errors.md +17 -0
- package/docs/models/ExternalEvent.md +84 -0
- package/docs/models/File.md +339 -0
- package/docs/models/FileAction.md +13 -0
- package/docs/models/FileComment.md +98 -0
- package/docs/models/FileCommentReaction.md +50 -0
- package/docs/models/FileMigration.md +40 -0
- package/docs/models/FileUploadPart.md +39 -0
- package/docs/models/Folder.md +90 -0
- package/docs/models/FormField.md +29 -0
- package/docs/models/FormFieldSet.md +170 -0
- package/docs/models/Group.md +140 -0
- package/docs/models/GroupUser.md +116 -0
- package/docs/models/History.md +151 -0
- package/docs/models/HistoryExport.md +130 -0
- package/docs/models/HistoryExportResult.md +75 -0
- package/docs/models/Image.md +13 -0
- package/docs/models/InboxRecipient.md +76 -0
- package/docs/models/InboxRegistration.md +47 -0
- package/docs/models/InboxUpload.md +42 -0
- package/docs/models/Invoice.md +82 -0
- package/docs/models/InvoiceLineItem.md +27 -0
- package/docs/models/IpAddress.md +51 -0
- package/docs/models/Lock.md +92 -0
- package/docs/models/Message.md +134 -0
- package/docs/models/MessageComment.md +114 -0
- package/docs/models/MessageCommentReaction.md +79 -0
- package/docs/models/MessageReaction.md +79 -0
- package/docs/models/Notification.md +241 -0
- package/docs/models/Payment.md +82 -0
- package/docs/models/PaymentLineItem.md +19 -0
- package/docs/models/Permission.md +94 -0
- package/docs/models/Preview.md +19 -0
- package/docs/models/Priority.md +30 -0
- package/docs/models/Project.md +98 -0
- package/docs/models/PublicIpAddress.md +17 -0
- package/docs/models/PublicKey.md +112 -0
- package/docs/models/RemoteBandwidthSnapshot.md +42 -0
- package/docs/models/RemoteServer.md +385 -0
- package/docs/models/Request.md +97 -0
- package/docs/models/Session.md +50 -0
- package/docs/models/SettingsChange.md +44 -0
- package/docs/models/Site.md +607 -0
- package/docs/models/SsoStrategy.md +139 -0
- package/docs/models/Status.md +30 -0
- package/docs/models/Style.md +76 -0
- package/docs/models/UsageDailySnapshot.md +56 -0
- package/docs/models/UsageSnapshot.md +63 -0
- package/docs/models/User.md +465 -0
- package/docs/models/UserCipherUse.md +39 -0
- package/docs/models/UserRequest.md +80 -0
- package/docs/models/WebhookTest.md +59 -0
- package/lib/Api.js +12 -11
- package/lib/Errors.js +3126 -0
- package/lib/models/AccountLineItem.js +8 -0
- package/lib/models/Action.js +8 -0
- package/lib/models/ActionNotificationExport.js +21 -13
- package/lib/models/ActionNotificationExportResult.js +13 -5
- package/lib/models/ActionWebhookFailure.js +12 -4
- package/lib/models/ApiKey.js +33 -25
- package/lib/models/App.js +10 -2
- package/lib/models/As2IncomingMessage.js +11 -3
- package/lib/models/As2OutgoingMessage.js +11 -3
- package/lib/models/As2Partner.js +34 -26
- package/lib/models/As2Station.js +32 -24
- package/lib/models/Auto.js +8 -0
- package/lib/models/Automation.js +54 -60
- package/lib/models/AutomationRun.js +16 -8
- package/lib/models/BandwidthSnapshot.js +10 -2
- package/lib/models/Behavior.js +46 -38
- package/lib/models/Bundle.js +51 -43
- package/lib/models/BundleDownload.js +12 -4
- package/lib/models/BundleRecipient.js +22 -14
- package/lib/models/BundleRegistration.js +12 -4
- package/lib/models/Clickwrap.js +31 -23
- package/lib/models/DnsRecord.js +10 -2
- package/lib/models/Errors.js +8 -0
- package/lib/models/ExternalEvent.js +18 -10
- package/lib/models/File.js +68 -60
- package/lib/models/FileAction.js +8 -0
- package/lib/models/FileComment.js +27 -19
- package/lib/models/FileCommentReaction.js +18 -10
- package/lib/models/FileMigration.js +11 -3
- package/lib/models/FileUploadPart.js +8 -0
- package/lib/models/Folder.js +19 -11
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -19
- package/lib/models/Group.js +30 -22
- package/lib/models/GroupUser.js +32 -24
- package/lib/models/History.js +42 -34
- package/lib/models/HistoryExport.js +34 -26
- package/lib/models/HistoryExportResult.js +13 -5
- package/lib/models/Image.js +8 -0
- package/lib/models/InboxRecipient.js +22 -14
- package/lib/models/InboxRegistration.js +11 -3
- package/lib/models/InboxUpload.js +12 -4
- package/lib/models/Invoice.js +13 -5
- package/lib/models/InvoiceLineItem.js +8 -0
- package/lib/models/IpAddress.js +12 -4
- package/lib/models/Lock.js +24 -16
- package/lib/models/Message.js +37 -29
- package/lib/models/MessageComment.js +29 -21
- package/lib/models/MessageCommentReaction.js +24 -16
- package/lib/models/MessageReaction.js +24 -16
- package/lib/models/Notification.js +38 -30
- package/lib/models/Payment.js +13 -5
- package/lib/models/PaymentLineItem.js +8 -0
- package/lib/models/Permission.js +23 -15
- package/lib/models/Preview.js +8 -0
- package/lib/models/Priority.js +13 -5
- package/lib/models/Project.js +25 -17
- package/lib/models/PublicIpAddress.js +8 -0
- package/lib/models/PublicKey.js +29 -21
- package/lib/models/RemoteBandwidthSnapshot.js +10 -2
- package/lib/models/RemoteServer.js +226 -196
- package/lib/models/Request.js +27 -19
- package/lib/models/Session.js +13 -5
- package/lib/models/SettingsChange.js +10 -2
- package/lib/models/Site.js +65 -57
- package/lib/models/SsoStrategy.js +17 -9
- package/lib/models/Status.js +8 -0
- package/lib/models/Style.js +20 -12
- package/lib/models/UsageDailySnapshot.js +10 -2
- package/lib/models/UsageSnapshot.js +10 -2
- package/lib/models/User.js +85 -77
- package/lib/models/UserCipherUse.js +11 -3
- package/lib/models/UserRequest.js +24 -16
- package/lib/models/WebhookTest.js +16 -8
- package/package.json +1 -1
- package/src/Api.js +4 -8
- package/src/Errors.js +222 -0
- package/src/models/AccountLineItem.js +1 -0
- package/src/models/Action.js +1 -0
- package/src/models/ActionNotificationExport.js +14 -13
- package/src/models/ActionNotificationExportResult.js +6 -5
- package/src/models/ActionWebhookFailure.js +5 -4
- package/src/models/ApiKey.js +26 -25
- package/src/models/App.js +3 -2
- package/src/models/As2IncomingMessage.js +4 -3
- package/src/models/As2OutgoingMessage.js +4 -3
- package/src/models/As2Partner.js +27 -26
- package/src/models/As2Station.js +25 -24
- package/src/models/Auto.js +1 -0
- package/src/models/Automation.js +51 -62
- package/src/models/AutomationRun.js +9 -8
- package/src/models/BandwidthSnapshot.js +3 -2
- package/src/models/Behavior.js +39 -38
- package/src/models/Bundle.js +44 -43
- package/src/models/BundleDownload.js +5 -4
- package/src/models/BundleRecipient.js +15 -14
- package/src/models/BundleRegistration.js +5 -4
- package/src/models/Clickwrap.js +24 -23
- package/src/models/DnsRecord.js +3 -2
- package/src/models/Errors.js +1 -0
- package/src/models/ExternalEvent.js +11 -10
- package/src/models/File.js +61 -60
- package/src/models/FileAction.js +1 -0
- package/src/models/FileComment.js +20 -19
- package/src/models/FileCommentReaction.js +11 -10
- package/src/models/FileMigration.js +4 -3
- package/src/models/FileUploadPart.js +1 -0
- package/src/models/Folder.js +12 -11
- package/src/models/FormField.js +1 -0
- package/src/models/FormFieldSet.js +20 -19
- package/src/models/Group.js +23 -22
- package/src/models/GroupUser.js +25 -24
- package/src/models/History.js +35 -34
- package/src/models/HistoryExport.js +27 -26
- package/src/models/HistoryExportResult.js +6 -5
- package/src/models/Image.js +1 -0
- package/src/models/InboxRecipient.js +15 -14
- package/src/models/InboxRegistration.js +4 -3
- package/src/models/InboxUpload.js +5 -4
- package/src/models/Invoice.js +6 -5
- package/src/models/InvoiceLineItem.js +1 -0
- package/src/models/IpAddress.js +5 -4
- package/src/models/Lock.js +17 -16
- package/src/models/Message.js +30 -29
- package/src/models/MessageComment.js +22 -21
- package/src/models/MessageCommentReaction.js +17 -16
- package/src/models/MessageReaction.js +17 -16
- package/src/models/Notification.js +31 -30
- package/src/models/Payment.js +6 -5
- package/src/models/PaymentLineItem.js +1 -0
- package/src/models/Permission.js +16 -15
- package/src/models/Preview.js +3 -2
- package/src/models/Priority.js +6 -5
- package/src/models/Project.js +18 -17
- package/src/models/PublicIpAddress.js +1 -0
- package/src/models/PublicKey.js +22 -21
- package/src/models/RemoteBandwidthSnapshot.js +3 -2
- package/src/models/RemoteServer.js +120 -103
- package/src/models/Request.js +20 -19
- package/src/models/Session.js +6 -5
- package/src/models/SettingsChange.js +3 -2
- package/src/models/Site.js +58 -57
- package/src/models/SsoStrategy.js +10 -9
- package/src/models/Status.js +1 -0
- package/src/models/Style.js +13 -12
- package/src/models/UsageDailySnapshot.js +3 -2
- package/src/models/UsageSnapshot.js +3 -2
- package/src/models/User.js +78 -77
- package/src/models/UserCipherUse.js +4 -3
- package/src/models/UserRequest.js +17 -16
- package/src/models/WebhookTest.js +9 -8
- package/test/src/index.js +46 -0
@@ -0,0 +1,607 @@
|
|
1
|
+
# Site
|
2
|
+
|
3
|
+
## Example Site Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"name": "My Site",
|
8
|
+
"allowed_2fa_method_sms": true,
|
9
|
+
"allowed_2fa_method_totp": true,
|
10
|
+
"allowed_2fa_method_u2f": true,
|
11
|
+
"allowed_2fa_method_webauthn": true,
|
12
|
+
"allowed_2fa_method_yubi": true,
|
13
|
+
"allowed_2fa_method_bypass_for_ftp_sftp_dav": true,
|
14
|
+
"admin_user_id": 1,
|
15
|
+
"allow_bundle_names": true,
|
16
|
+
"allowed_countries": "US,DE",
|
17
|
+
"allowed_ips": "",
|
18
|
+
"ask_about_overwrites": true,
|
19
|
+
"bundle_expiration": 1,
|
20
|
+
"bundle_password_required": true,
|
21
|
+
"bundle_require_share_recipient": true,
|
22
|
+
"bundle_watermark_attachment": {
|
23
|
+
"name": "My logo",
|
24
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
25
|
+
},
|
26
|
+
"bundle_watermark_value": "",
|
27
|
+
"color2_left": "#0066a7",
|
28
|
+
"color2_link": "#d34f5d",
|
29
|
+
"color2_text": "#0066a7",
|
30
|
+
"color2_top": "#000000",
|
31
|
+
"color2_top_text": "#ffffff",
|
32
|
+
"contact_name": "John Doe",
|
33
|
+
"created_at": "2000-01-01T01:00:00Z",
|
34
|
+
"currency": "USD",
|
35
|
+
"custom_namespace": true,
|
36
|
+
"days_to_retain_backups": 30,
|
37
|
+
"default_time_zone": "Pacific Time (US & Canada)",
|
38
|
+
"desktop_app": true,
|
39
|
+
"desktop_app_session_ip_pinning": true,
|
40
|
+
"desktop_app_session_lifetime": 1,
|
41
|
+
"mobile_app": true,
|
42
|
+
"mobile_app_session_ip_pinning": true,
|
43
|
+
"mobile_app_session_lifetime": 1,
|
44
|
+
"disallowed_countries": "US,DE",
|
45
|
+
"disable_notifications": true,
|
46
|
+
"disable_password_reset": true,
|
47
|
+
"domain": "my-custom-domain.com",
|
48
|
+
"domain_hsts_header": true,
|
49
|
+
"domain_letsencrypt_chain": "",
|
50
|
+
"email": "john.doe@files.com",
|
51
|
+
"ftp_enabled": true,
|
52
|
+
"reply_to_email": "jane.doe@files.com",
|
53
|
+
"non_sso_groups_allowed": true,
|
54
|
+
"non_sso_users_allowed": true,
|
55
|
+
"folder_permissions_groups_only": true,
|
56
|
+
"hipaa": true,
|
57
|
+
"icon128": {
|
58
|
+
"name": "My logo",
|
59
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
60
|
+
},
|
61
|
+
"icon16": {
|
62
|
+
"name": "My logo",
|
63
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
64
|
+
},
|
65
|
+
"icon32": {
|
66
|
+
"name": "My logo",
|
67
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
68
|
+
},
|
69
|
+
"icon48": {
|
70
|
+
"name": "My logo",
|
71
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
72
|
+
},
|
73
|
+
"immutable_files_set_at": "2000-01-01T01:00:00Z",
|
74
|
+
"include_password_in_welcome_email": true,
|
75
|
+
"language": "en",
|
76
|
+
"ldap_base_dn": "",
|
77
|
+
"ldap_domain": "mysite.com",
|
78
|
+
"ldap_enabled": true,
|
79
|
+
"ldap_group_action": "disabled",
|
80
|
+
"ldap_group_exclusion": "",
|
81
|
+
"ldap_group_inclusion": "",
|
82
|
+
"ldap_host": "ldap.site.com",
|
83
|
+
"ldap_host_2": "ldap2.site.com",
|
84
|
+
"ldap_host_3": "ldap3.site.com",
|
85
|
+
"ldap_port": 1,
|
86
|
+
"ldap_secure": true,
|
87
|
+
"ldap_type": "open_ldap",
|
88
|
+
"ldap_user_action": "disabled",
|
89
|
+
"ldap_user_include_groups": "",
|
90
|
+
"ldap_username": "[ldap username]",
|
91
|
+
"ldap_username_field": "sAMAccountName",
|
92
|
+
"login_help_text": "Login page help text.",
|
93
|
+
"logo": {
|
94
|
+
"name": "My logo",
|
95
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
96
|
+
},
|
97
|
+
"max_prior_passwords": 1,
|
98
|
+
"next_billing_amount": 1.0,
|
99
|
+
"next_billing_date": "Apr 20",
|
100
|
+
"office_integration_available": true,
|
101
|
+
"oncehub_link": "https://go.oncehub.com/files",
|
102
|
+
"opt_out_global": true,
|
103
|
+
"overage_notified_at": "2000-01-01T01:00:00Z",
|
104
|
+
"overage_notify": true,
|
105
|
+
"overdue": true,
|
106
|
+
"password_min_length": 1,
|
107
|
+
"password_require_letter": true,
|
108
|
+
"password_require_mixed": true,
|
109
|
+
"password_require_number": true,
|
110
|
+
"password_require_special": true,
|
111
|
+
"password_require_unbreached": true,
|
112
|
+
"password_requirements_apply_to_bundles": true,
|
113
|
+
"password_validity_days": 1,
|
114
|
+
"phone": "555-555-5555",
|
115
|
+
"require_2fa": true,
|
116
|
+
"require_2fa_stop_time": "2000-01-01T01:00:00Z",
|
117
|
+
"require_2fa_user_type": "`site_admins`",
|
118
|
+
"session": {
|
119
|
+
"id": "60525f92e859c4c3d74cb02fd176b1525901b525",
|
120
|
+
"language": "en",
|
121
|
+
"login_token": "@tok-randomcode",
|
122
|
+
"login_token_domain": "https://mysite.files.com",
|
123
|
+
"max_dir_listing_size": false,
|
124
|
+
"multiple_regions": true,
|
125
|
+
"read_only": true,
|
126
|
+
"root_path": "",
|
127
|
+
"sftp_insecure_ciphers": false,
|
128
|
+
"site_id": 1,
|
129
|
+
"ssl_required": true,
|
130
|
+
"tls_disabled": false,
|
131
|
+
"two_factor_setup_needed": false,
|
132
|
+
"allowed_2fa_method_sms": true,
|
133
|
+
"allowed_2fa_method_totp": true,
|
134
|
+
"allowed_2fa_method_u2f": true,
|
135
|
+
"allowed_2fa_method_webauthn": true,
|
136
|
+
"allowed_2fa_method_yubi": true,
|
137
|
+
"use_provided_modified_at": true,
|
138
|
+
"windows_mode_ftp": false
|
139
|
+
},
|
140
|
+
"session_pinned_by_ip": true,
|
141
|
+
"sftp_enabled": true,
|
142
|
+
"sftp_insecure_ciphers": true,
|
143
|
+
"sftp_user_root_enabled": true,
|
144
|
+
"sharing_enabled": true,
|
145
|
+
"show_request_access_link": true,
|
146
|
+
"site_footer": "",
|
147
|
+
"site_header": "",
|
148
|
+
"smtp_address": "smtp.my-mail-server.com",
|
149
|
+
"smtp_authentication": "plain",
|
150
|
+
"smtp_from": "me@my-mail-server.com",
|
151
|
+
"smtp_port": 25,
|
152
|
+
"smtp_username": "mail",
|
153
|
+
"session_expiry": 6.0,
|
154
|
+
"ssl_required": true,
|
155
|
+
"subdomain": "mysite",
|
156
|
+
"switch_to_plan_date": "2000-01-01T01:00:00Z",
|
157
|
+
"tls_disabled": true,
|
158
|
+
"trial_days_left": 1,
|
159
|
+
"trial_until": "2000-01-01T01:00:00Z",
|
160
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
161
|
+
"use_provided_modified_at": true,
|
162
|
+
"user": {
|
163
|
+
"id": 1,
|
164
|
+
"username": "user",
|
165
|
+
"admin_group_ids": [
|
166
|
+
1
|
167
|
+
],
|
168
|
+
"allowed_ips": "127.0.0.1",
|
169
|
+
"attachments_permission": true,
|
170
|
+
"api_keys_count": 1,
|
171
|
+
"authenticate_until": "2000-01-01T01:00:00Z",
|
172
|
+
"authentication_method": "password",
|
173
|
+
"avatar_url": "",
|
174
|
+
"billing_permission": false,
|
175
|
+
"bypass_site_allowed_ips": false,
|
176
|
+
"bypass_inactive_disable": false,
|
177
|
+
"created_at": "2000-01-01T01:00:00Z",
|
178
|
+
"dav_permission": true,
|
179
|
+
"disabled": true,
|
180
|
+
"email": "john.doe@files.com",
|
181
|
+
"ftp_permission": true,
|
182
|
+
"group_ids": "",
|
183
|
+
"header_text": "User-specific message.",
|
184
|
+
"language": "en",
|
185
|
+
"last_login_at": "2000-01-01T01:00:00Z",
|
186
|
+
"last_protocol_cipher": "",
|
187
|
+
"lockout_expires": "2000-01-01T01:00:00Z",
|
188
|
+
"name": "John Doe",
|
189
|
+
"company": "ACME Corp.",
|
190
|
+
"notes": "Internal notes on this user.",
|
191
|
+
"notification_daily_send_time": 18,
|
192
|
+
"office_integration_enabled": true,
|
193
|
+
"password_set_at": "2000-01-01T01:00:00Z",
|
194
|
+
"password_validity_days": 1,
|
195
|
+
"public_keys_count": 1,
|
196
|
+
"receive_admin_alerts": true,
|
197
|
+
"require_2fa": "always_require",
|
198
|
+
"active_2fa": true,
|
199
|
+
"require_password_change": true,
|
200
|
+
"password_expired": true,
|
201
|
+
"restapi_permission": true,
|
202
|
+
"self_managed": true,
|
203
|
+
"sftp_permission": true,
|
204
|
+
"site_admin": true,
|
205
|
+
"skip_welcome_screen": true,
|
206
|
+
"ssl_required": "always_require",
|
207
|
+
"sso_strategy_id": 1,
|
208
|
+
"subscribe_to_newsletter": true,
|
209
|
+
"externally_managed": true,
|
210
|
+
"time_zone": "Pacific Time (US & Canada)",
|
211
|
+
"type_of_2fa": "yubi",
|
212
|
+
"user_root": ""
|
213
|
+
},
|
214
|
+
"user_lockout": true,
|
215
|
+
"user_lockout_lock_period": 1,
|
216
|
+
"user_lockout_tries": 1,
|
217
|
+
"user_lockout_within": 6,
|
218
|
+
"user_requests_enabled": true,
|
219
|
+
"welcome_custom_text": "Welcome to my site!",
|
220
|
+
"welcome_email_cc": "",
|
221
|
+
"welcome_email_subject": "",
|
222
|
+
"welcome_email_enabled": true,
|
223
|
+
"welcome_screen": "user_controlled",
|
224
|
+
"windows_mode_ftp": true,
|
225
|
+
"disable_users_from_inactivity_period_days": 1
|
226
|
+
}
|
227
|
+
```
|
228
|
+
|
229
|
+
* `name` (string): Site name
|
230
|
+
* `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
|
231
|
+
* `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
|
232
|
+
* `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
|
233
|
+
* `allowed_2fa_method_webauthn` (boolean): Is WebAuthn two factor authentication allowed?
|
234
|
+
* `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
|
235
|
+
* `allowed_2fa_method_bypass_for_ftp_sftp_dav` (boolean): Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
|
236
|
+
* `admin_user_id` (int64): User ID for the main site administrator
|
237
|
+
* `allow_bundle_names` (boolean): Are manual Bundle names allowed?
|
238
|
+
* `allowed_countries` (string): Comma seperated list of allowed Country codes
|
239
|
+
* `allowed_ips` (string): List of allowed IP addresses
|
240
|
+
* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
241
|
+
* `bundle_expiration` (int64): Site-wide Bundle expiration in days
|
242
|
+
* `bundle_password_required` (boolean): Do Bundles require password protection?
|
243
|
+
* `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
|
244
|
+
* `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
245
|
+
* `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
246
|
+
* `color2_left` (string): Page link and button color
|
247
|
+
* `color2_link` (string): Top bar link color
|
248
|
+
* `color2_text` (string): Page link and button color
|
249
|
+
* `color2_top` (string): Top bar background color
|
250
|
+
* `color2_top_text` (string): Top bar text color
|
251
|
+
* `contact_name` (string): Site main contact name
|
252
|
+
* `created_at` (date-time): Time this site was created
|
253
|
+
* `currency` (string): Preferred currency
|
254
|
+
* `custom_namespace` (boolean): Is this site using a custom namespace for users?
|
255
|
+
* `days_to_retain_backups` (int64): Number of days to keep deleted files
|
256
|
+
* `default_time_zone` (string): Site default time zone
|
257
|
+
* `desktop_app` (boolean): Is the desktop app enabled?
|
258
|
+
* `desktop_app_session_ip_pinning` (boolean): Is desktop app session IP pinning enabled?
|
259
|
+
* `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
|
260
|
+
* `mobile_app` (boolean): Is the mobile app enabled?
|
261
|
+
* `mobile_app_session_ip_pinning` (boolean): Is mobile app session IP pinning enabled?
|
262
|
+
* `mobile_app_session_lifetime` (int64): Mobile app session lifetime (in hours)
|
263
|
+
* `disallowed_countries` (string): Comma seperated list of disallowed Country codes
|
264
|
+
* `disable_notifications` (boolean): Are notifications disabled?
|
265
|
+
* `disable_password_reset` (boolean): Is password reset disabled?
|
266
|
+
* `domain` (string): Custom domain
|
267
|
+
* `domain_hsts_header` (boolean): Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
|
268
|
+
* `domain_letsencrypt_chain` (string): Letsencrypt chain to use when registering SSL Certificate for domain.
|
269
|
+
* `email` (email): Main email for this site
|
270
|
+
* `ftp_enabled` (boolean): Is FTP enabled?
|
271
|
+
* `reply_to_email` (email): Reply-to email for this site
|
272
|
+
* `non_sso_groups_allowed` (boolean): If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
|
273
|
+
* `non_sso_users_allowed` (boolean): If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
|
274
|
+
* `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
|
275
|
+
* `hipaa` (boolean): Is there a signed HIPAA BAA between Files.com and this site?
|
276
|
+
* `icon128` (Image): Branded icon 128x128
|
277
|
+
* `icon16` (Image): Branded icon 16x16
|
278
|
+
* `icon32` (Image): Branded icon 32x32
|
279
|
+
* `icon48` (Image): Branded icon 48x48
|
280
|
+
* `immutable_files_set_at` (date-time): Can files be modified?
|
281
|
+
* `include_password_in_welcome_email` (boolean): Include password in emails to new users?
|
282
|
+
* `language` (string): Site default language
|
283
|
+
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
284
|
+
* `ldap_domain` (string): Domain name that will be appended to usernames
|
285
|
+
* `ldap_enabled` (boolean): Main LDAP setting: is LDAP enabled?
|
286
|
+
* `ldap_group_action` (string): Should we sync groups from LDAP server?
|
287
|
+
* `ldap_group_exclusion` (string): Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
|
288
|
+
* `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
|
289
|
+
* `ldap_host` (string): LDAP host
|
290
|
+
* `ldap_host_2` (string): LDAP backup host
|
291
|
+
* `ldap_host_3` (string): LDAP backup host
|
292
|
+
* `ldap_port` (int64): LDAP port
|
293
|
+
* `ldap_secure` (boolean): Use secure LDAP?
|
294
|
+
* `ldap_type` (string): LDAP type
|
295
|
+
* `ldap_user_action` (string): Should we sync users from LDAP server?
|
296
|
+
* `ldap_user_include_groups` (string): Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
|
297
|
+
* `ldap_username` (string): Username for signing in to LDAP server.
|
298
|
+
* `ldap_username_field` (string): LDAP username field
|
299
|
+
* `login_help_text` (string): Login help text
|
300
|
+
* `logo` (Image): Branded logo
|
301
|
+
* `max_prior_passwords` (int64): Number of prior passwords to disallow
|
302
|
+
* `next_billing_amount` (double): Next billing amount
|
303
|
+
* `next_billing_date` (string): Next billing date
|
304
|
+
* `office_integration_available` (boolean): Allow users to use Office for the web?
|
305
|
+
* `oncehub_link` (string): Link to scheduling a meeting with our Sales team
|
306
|
+
* `opt_out_global` (boolean): Use servers in the USA only?
|
307
|
+
* `overage_notified_at` (date-time): Last time the site was notified about an overage
|
308
|
+
* `overage_notify` (boolean): Notify site email of overages?
|
309
|
+
* `overdue` (boolean): Is this site's billing overdue?
|
310
|
+
* `password_min_length` (int64): Shortest password length for users
|
311
|
+
* `password_require_letter` (boolean): Require a letter in passwords?
|
312
|
+
* `password_require_mixed` (boolean): Require lower and upper case letters in passwords?
|
313
|
+
* `password_require_number` (boolean): Require a number in passwords?
|
314
|
+
* `password_require_special` (boolean): Require special characters in password?
|
315
|
+
* `password_require_unbreached` (boolean): Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
|
316
|
+
* `password_requirements_apply_to_bundles` (boolean): Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
|
317
|
+
* `password_validity_days` (int64): Number of days password is valid
|
318
|
+
* `phone` (string): Site phone number
|
319
|
+
* `require_2fa` (boolean): Require two-factor authentication for all users?
|
320
|
+
* `require_2fa_stop_time` (date-time): If set, requirement for two-factor authentication has been scheduled to end on this date-time.
|
321
|
+
* `require_2fa_user_type` (string): What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
|
322
|
+
* `session` (Session): Current session
|
323
|
+
* `session_pinned_by_ip` (boolean): Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
|
324
|
+
* `sftp_enabled` (boolean): Is SFTP enabled?
|
325
|
+
* `sftp_insecure_ciphers` (boolean): Are Insecure Ciphers allowed for SFTP? Note: Settting TLS Disabled -> True will always allow insecure ciphers for SFTP as well. Enabling this is insecure.
|
326
|
+
* `sftp_user_root_enabled` (boolean): Use user FTP roots also for SFTP?
|
327
|
+
* `sharing_enabled` (boolean): Allow bundle creation
|
328
|
+
* `show_request_access_link` (boolean): Show request access link for users without access? Currently unused.
|
329
|
+
* `site_footer` (string): Custom site footer text
|
330
|
+
* `site_header` (string): Custom site header text
|
331
|
+
* `smtp_address` (string): SMTP server hostname or IP
|
332
|
+
* `smtp_authentication` (string): SMTP server authentication type
|
333
|
+
* `smtp_from` (string): From address to use when mailing through custom SMTP
|
334
|
+
* `smtp_port` (int64): SMTP server port
|
335
|
+
* `smtp_username` (string): SMTP server username
|
336
|
+
* `session_expiry` (double): Session expiry in hours
|
337
|
+
* `ssl_required` (boolean): Is SSL required? Disabling this is insecure.
|
338
|
+
* `subdomain` (string): Site subdomain
|
339
|
+
* `switch_to_plan_date` (date-time): If switching plans, when does the new plan take effect?
|
340
|
+
* `tls_disabled` (boolean): Are Insecure TLS and SFTP Ciphers allowed? Enabling this is insecure.
|
341
|
+
* `trial_days_left` (int64): Number of days left in trial
|
342
|
+
* `trial_until` (date-time): When does this Site trial expire?
|
343
|
+
* `updated_at` (date-time): Last time this Site was updated
|
344
|
+
* `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?
|
345
|
+
* `user` (User): User of current session
|
346
|
+
* `user_lockout` (boolean): Will users be locked out after incorrect login attempts?
|
347
|
+
* `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
|
348
|
+
* `user_lockout_tries` (int64): Number of login tries within `user_lockout_within` hours before users are locked out
|
349
|
+
* `user_lockout_within` (int64): Number of hours for user lockout window
|
350
|
+
* `user_requests_enabled` (boolean): Enable User Requests feature
|
351
|
+
* `welcome_custom_text` (string): Custom text send in user welcome email
|
352
|
+
* `welcome_email_cc` (email): Include this email in welcome emails if enabled
|
353
|
+
* `welcome_email_subject` (string): Include this email subject in welcome emails if enabled
|
354
|
+
* `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
|
355
|
+
* `welcome_screen` (string): Does the welcome screen appear?
|
356
|
+
* `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
|
357
|
+
* `disable_users_from_inactivity_period_days` (int64): If greater than zero, users will unable to login if they do not show activity within this number of days.
|
358
|
+
|
359
|
+
---
|
360
|
+
|
361
|
+
## Show site settings
|
362
|
+
|
363
|
+
```
|
364
|
+
await Site.get
|
365
|
+
```
|
366
|
+
|
367
|
+
|
368
|
+
---
|
369
|
+
|
370
|
+
## Get the most recent usage snapshot (usage data for billing purposes) for a Site
|
371
|
+
|
372
|
+
```
|
373
|
+
await Site.getUsage
|
374
|
+
```
|
375
|
+
|
376
|
+
|
377
|
+
---
|
378
|
+
|
379
|
+
## Update site settings
|
380
|
+
|
381
|
+
```
|
382
|
+
await Site.update({
|
383
|
+
'name': "My Site",
|
384
|
+
'subdomain': "mysite",
|
385
|
+
'domain': "my-custom-domain.com",
|
386
|
+
'domain_hsts_header': true,
|
387
|
+
'email': "john.doe@files.com",
|
388
|
+
'reply_to_email': "jane.doe@files.com",
|
389
|
+
'allow_bundle_names': true,
|
390
|
+
'bundle_expiration': 1,
|
391
|
+
'overage_notify': true,
|
392
|
+
'welcome_email_enabled': true,
|
393
|
+
'ask_about_overwrites': true,
|
394
|
+
'show_request_access_link': true,
|
395
|
+
'welcome_custom_text': "Welcome to my site!",
|
396
|
+
'language': "en",
|
397
|
+
'windows_mode_ftp': true,
|
398
|
+
'default_time_zone': "Pacific Time (US & Canada)",
|
399
|
+
'desktop_app': true,
|
400
|
+
'desktop_app_session_ip_pinning': true,
|
401
|
+
'desktop_app_session_lifetime': 1,
|
402
|
+
'mobile_app': true,
|
403
|
+
'mobile_app_session_ip_pinning': true,
|
404
|
+
'mobile_app_session_lifetime': 1,
|
405
|
+
'folder_permissions_groups_only': true,
|
406
|
+
'welcome_screen': "user_controlled",
|
407
|
+
'office_integration_available': true,
|
408
|
+
'session_expiry': 1.0,
|
409
|
+
'ssl_required': true,
|
410
|
+
'tls_disabled': true,
|
411
|
+
'sftp_insecure_ciphers': true,
|
412
|
+
'user_lockout': true,
|
413
|
+
'user_lockout_tries': 1,
|
414
|
+
'user_lockout_within': 1,
|
415
|
+
'user_lockout_lock_period': 1,
|
416
|
+
'include_password_in_welcome_email': true,
|
417
|
+
'allowed_countries': "US,DE",
|
418
|
+
'disallowed_countries': "US,DE",
|
419
|
+
'days_to_retain_backups': 1,
|
420
|
+
'max_prior_passwords': 1,
|
421
|
+
'password_validity_days': 1,
|
422
|
+
'password_min_length': 1,
|
423
|
+
'password_require_letter': true,
|
424
|
+
'password_require_mixed': true,
|
425
|
+
'password_require_special': true,
|
426
|
+
'password_require_number': true,
|
427
|
+
'password_require_unbreached': true,
|
428
|
+
'sftp_user_root_enabled': true,
|
429
|
+
'disable_password_reset': true,
|
430
|
+
'immutable_files': true,
|
431
|
+
'session_pinned_by_ip': true,
|
432
|
+
'bundle_password_required': true,
|
433
|
+
'bundle_require_share_recipient': true,
|
434
|
+
'password_requirements_apply_to_bundles': true,
|
435
|
+
'opt_out_global': true,
|
436
|
+
'use_provided_modified_at': true,
|
437
|
+
'custom_namespace': true,
|
438
|
+
'disable_users_from_inactivity_period_days': 1,
|
439
|
+
'non_sso_groups_allowed': true,
|
440
|
+
'non_sso_users_allowed': true,
|
441
|
+
'sharing_enabled': true,
|
442
|
+
'user_requests_enabled': true,
|
443
|
+
'ftp_enabled': true,
|
444
|
+
'sftp_enabled': true,
|
445
|
+
'allowed_2fa_method_sms': true,
|
446
|
+
'allowed_2fa_method_u2f': true,
|
447
|
+
'allowed_2fa_method_totp': true,
|
448
|
+
'allowed_2fa_method_webauthn': true,
|
449
|
+
'allowed_2fa_method_yubi': true,
|
450
|
+
'allowed_2fa_method_bypass_for_ftp_sftp_dav': true,
|
451
|
+
'require_2fa': true,
|
452
|
+
'require_2fa_user_type': "`site_admins`",
|
453
|
+
'color2_top': "#000000",
|
454
|
+
'color2_left': "#0066a7",
|
455
|
+
'color2_link': "#d34f5d",
|
456
|
+
'color2_text': "#0066a7",
|
457
|
+
'color2_top_text': "#ffffff",
|
458
|
+
'login_help_text': "Login page help text.",
|
459
|
+
'smtp_address': "smtp.my-mail-server.com",
|
460
|
+
'smtp_authentication': "plain",
|
461
|
+
'smtp_from': "me@my-mail-server.com",
|
462
|
+
'smtp_username': "mail",
|
463
|
+
'smtp_port': 1,
|
464
|
+
'ldap_enabled': true,
|
465
|
+
'ldap_type': "open_ldap",
|
466
|
+
'ldap_host': "ldap.site.com",
|
467
|
+
'ldap_host_2': "ldap2.site.com",
|
468
|
+
'ldap_host_3': "ldap3.site.com",
|
469
|
+
'ldap_port': 1,
|
470
|
+
'ldap_secure': true,
|
471
|
+
'ldap_username': "[ldap username]",
|
472
|
+
'ldap_username_field': "sAMAccountName",
|
473
|
+
'ldap_domain': "mysite.com",
|
474
|
+
'ldap_user_action': "disabled",
|
475
|
+
'ldap_group_action': "disabled",
|
476
|
+
'icon16_delete': true,
|
477
|
+
'icon32_delete': true,
|
478
|
+
'icon48_delete': true,
|
479
|
+
'icon128_delete': true,
|
480
|
+
'logo_delete': true,
|
481
|
+
'bundle_watermark_attachment_delete': true,
|
482
|
+
'disable_2fa_with_delay': true,
|
483
|
+
})
|
484
|
+
```
|
485
|
+
|
486
|
+
|
487
|
+
### Parameters
|
488
|
+
|
489
|
+
* `name` (string): Site name
|
490
|
+
* `subdomain` (string): Site subdomain
|
491
|
+
* `domain` (string): Custom domain
|
492
|
+
* `domain_hsts_header` (boolean): Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
|
493
|
+
* `domain_letsencrypt_chain` (string): Letsencrypt chain to use when registering SSL Certificate for domain.
|
494
|
+
* `email` (string): Main email for this site
|
495
|
+
* `reply_to_email` (string): Reply-to email for this site
|
496
|
+
* `allow_bundle_names` (boolean): Are manual Bundle names allowed?
|
497
|
+
* `bundle_expiration` (int64): Site-wide Bundle expiration in days
|
498
|
+
* `overage_notify` (boolean): Notify site email of overages?
|
499
|
+
* `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
|
500
|
+
* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
501
|
+
* `show_request_access_link` (boolean): Show request access link for users without access? Currently unused.
|
502
|
+
* `welcome_email_cc` (string): Include this email in welcome emails if enabled
|
503
|
+
* `welcome_email_subject` (string): Include this email subject in welcome emails if enabled
|
504
|
+
* `welcome_custom_text` (string): Custom text send in user welcome email
|
505
|
+
* `language` (string): Site default language
|
506
|
+
* `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
|
507
|
+
* `default_time_zone` (string): Site default time zone
|
508
|
+
* `desktop_app` (boolean): Is the desktop app enabled?
|
509
|
+
* `desktop_app_session_ip_pinning` (boolean): Is desktop app session IP pinning enabled?
|
510
|
+
* `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
|
511
|
+
* `mobile_app` (boolean): Is the mobile app enabled?
|
512
|
+
* `mobile_app_session_ip_pinning` (boolean): Is mobile app session IP pinning enabled?
|
513
|
+
* `mobile_app_session_lifetime` (int64): Mobile app session lifetime (in hours)
|
514
|
+
* `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
|
515
|
+
* `welcome_screen` (string): Does the welcome screen appear?
|
516
|
+
* `office_integration_available` (boolean): Allow users to use Office for the web?
|
517
|
+
* `session_expiry` (double): Session expiry in hours
|
518
|
+
* `ssl_required` (boolean): Is SSL required? Disabling this is insecure.
|
519
|
+
* `tls_disabled` (boolean): Are Insecure TLS and SFTP Ciphers allowed? Enabling this is insecure.
|
520
|
+
* `sftp_insecure_ciphers` (boolean): Are Insecure Ciphers allowed for SFTP? Note: Settting TLS Disabled -> True will always allow insecure ciphers for SFTP as well. Enabling this is insecure.
|
521
|
+
* `user_lockout` (boolean): Will users be locked out after incorrect login attempts?
|
522
|
+
* `user_lockout_tries` (int64): Number of login tries within `user_lockout_within` hours before users are locked out
|
523
|
+
* `user_lockout_within` (int64): Number of hours for user lockout window
|
524
|
+
* `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
|
525
|
+
* `include_password_in_welcome_email` (boolean): Include password in emails to new users?
|
526
|
+
* `allowed_countries` (string): Comma seperated list of allowed Country codes
|
527
|
+
* `allowed_ips` (string): List of allowed IP addresses
|
528
|
+
* `disallowed_countries` (string): Comma seperated list of disallowed Country codes
|
529
|
+
* `days_to_retain_backups` (int64): Number of days to keep deleted files
|
530
|
+
* `max_prior_passwords` (int64): Number of prior passwords to disallow
|
531
|
+
* `password_validity_days` (int64): Number of days password is valid
|
532
|
+
* `password_min_length` (int64): Shortest password length for users
|
533
|
+
* `password_require_letter` (boolean): Require a letter in passwords?
|
534
|
+
* `password_require_mixed` (boolean): Require lower and upper case letters in passwords?
|
535
|
+
* `password_require_special` (boolean): Require special characters in password?
|
536
|
+
* `password_require_number` (boolean): Require a number in passwords?
|
537
|
+
* `password_require_unbreached` (boolean): Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
|
538
|
+
* `sftp_user_root_enabled` (boolean): Use user FTP roots also for SFTP?
|
539
|
+
* `disable_password_reset` (boolean): Is password reset disabled?
|
540
|
+
* `immutable_files` (boolean): Are files protected from modification?
|
541
|
+
* `session_pinned_by_ip` (boolean): Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
|
542
|
+
* `bundle_password_required` (boolean): Do Bundles require password protection?
|
543
|
+
* `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
|
544
|
+
* `password_requirements_apply_to_bundles` (boolean): Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
|
545
|
+
* `opt_out_global` (boolean): Use servers in the USA only?
|
546
|
+
* `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?
|
547
|
+
* `custom_namespace` (boolean): Is this site using a custom namespace for users?
|
548
|
+
* `disable_users_from_inactivity_period_days` (int64): If greater than zero, users will unable to login if they do not show activity within this number of days.
|
549
|
+
* `non_sso_groups_allowed` (boolean): If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
|
550
|
+
* `non_sso_users_allowed` (boolean): If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
|
551
|
+
* `sharing_enabled` (boolean): Allow bundle creation
|
552
|
+
* `user_requests_enabled` (boolean): Enable User Requests feature
|
553
|
+
* `ftp_enabled` (boolean): Is FTP enabled?
|
554
|
+
* `sftp_enabled` (boolean): Is SFTP enabled?
|
555
|
+
* `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
|
556
|
+
* `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
|
557
|
+
* `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
|
558
|
+
* `allowed_2fa_method_webauthn` (boolean): Is WebAuthn two factor authentication allowed?
|
559
|
+
* `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
|
560
|
+
* `allowed_2fa_method_bypass_for_ftp_sftp_dav` (boolean): Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
|
561
|
+
* `require_2fa` (boolean): Require two-factor authentication for all users?
|
562
|
+
* `require_2fa_user_type` (string): What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
|
563
|
+
* `color2_top` (string): Top bar background color
|
564
|
+
* `color2_left` (string): Page link and button color
|
565
|
+
* `color2_link` (string): Top bar link color
|
566
|
+
* `color2_text` (string): Page link and button color
|
567
|
+
* `color2_top_text` (string): Top bar text color
|
568
|
+
* `site_header` (string): Custom site header text
|
569
|
+
* `site_footer` (string): Custom site footer text
|
570
|
+
* `login_help_text` (string): Login help text
|
571
|
+
* `smtp_address` (string): SMTP server hostname or IP
|
572
|
+
* `smtp_authentication` (string): SMTP server authentication type
|
573
|
+
* `smtp_from` (string): From address to use when mailing through custom SMTP
|
574
|
+
* `smtp_username` (string): SMTP server username
|
575
|
+
* `smtp_port` (int64): SMTP server port
|
576
|
+
* `ldap_enabled` (boolean): Main LDAP setting: is LDAP enabled?
|
577
|
+
* `ldap_type` (string): LDAP type
|
578
|
+
* `ldap_host` (string): LDAP host
|
579
|
+
* `ldap_host_2` (string): LDAP backup host
|
580
|
+
* `ldap_host_3` (string): LDAP backup host
|
581
|
+
* `ldap_port` (int64): LDAP port
|
582
|
+
* `ldap_secure` (boolean): Use secure LDAP?
|
583
|
+
* `ldap_username` (string): Username for signing in to LDAP server.
|
584
|
+
* `ldap_username_field` (string): LDAP username field
|
585
|
+
* `ldap_domain` (string): Domain name that will be appended to usernames
|
586
|
+
* `ldap_user_action` (string): Should we sync users from LDAP server?
|
587
|
+
* `ldap_group_action` (string): Should we sync groups from LDAP server?
|
588
|
+
* `ldap_user_include_groups` (string): Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
|
589
|
+
* `ldap_group_exclusion` (string): Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
|
590
|
+
* `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
|
591
|
+
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
592
|
+
* `icon16_file` (file):
|
593
|
+
* `icon16_delete` (boolean): If true, will delete the file stored in icon16
|
594
|
+
* `icon32_file` (file):
|
595
|
+
* `icon32_delete` (boolean): If true, will delete the file stored in icon32
|
596
|
+
* `icon48_file` (file):
|
597
|
+
* `icon48_delete` (boolean): If true, will delete the file stored in icon48
|
598
|
+
* `icon128_file` (file):
|
599
|
+
* `icon128_delete` (boolean): If true, will delete the file stored in icon128
|
600
|
+
* `logo_file` (file):
|
601
|
+
* `logo_delete` (boolean): If true, will delete the file stored in logo
|
602
|
+
* `bundle_watermark_attachment_file` (file):
|
603
|
+
* `bundle_watermark_attachment_delete` (boolean): If true, will delete the file stored in bundle_watermark_attachment
|
604
|
+
* `disable_2fa_with_delay` (boolean): If set to true, we will begin the process of disabling 2FA on this site.
|
605
|
+
* `ldap_password_change` (string): New LDAP password.
|
606
|
+
* `ldap_password_change_confirmation` (string): Confirm new LDAP password.
|
607
|
+
* `smtp_password` (string): Password for SMTP server.
|