files.com 1.1.669 → 1.1.671
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -0
- data/_VERSION +1 -1
- data/docs/account.md +155 -0
- data/docs/action_log.md +21 -1
- data/docs/action_notification_export_result.md +17 -0
- data/docs/action_webhook_failure.md +28 -0
- data/docs/agent_proxy_identity.md +49 -0
- data/docs/agent_proxy_identity_endpoint.md +11 -0
- data/docs/agent_proxy_identity_result.md +24 -0
- data/docs/agent_v2_auth.md +17 -0
- data/docs/ai_assistant_personality.md +14 -0
- data/docs/ai_task.md +14 -0
- data/docs/announcement.md +57 -0
- data/docs/api_key.md +27 -1
- data/docs/api_request_log.md +21 -1
- data/docs/app.md +15 -0
- data/docs/as2_incoming_message.md +18 -0
- data/docs/as2_outgoing_message.md +18 -0
- data/docs/as2_partner.md +14 -0
- data/docs/as2_station.md +14 -0
- data/docs/automation.md +22 -1
- data/docs/automation_log.md +21 -1
- data/docs/automation_run.md +19 -0
- data/docs/bandwidth_snapshot.md +18 -0
- data/docs/behavior.md +14 -0
- data/docs/blog_post.md +57 -0
- data/docs/bundle.md +50 -1
- data/docs/bundle_action.md +25 -0
- data/docs/bundle_download.md +23 -0
- data/docs/bundle_notification.md +19 -0
- data/docs/bundle_recipient.md +21 -0
- data/docs/bundle_recipient_registration.md +39 -0
- data/docs/bundle_registration.md +61 -0
- data/docs/certificate.md +258 -0
- data/docs/chat_session.md +14 -0
- data/docs/child_site.md +583 -0
- data/docs/child_site_management_policy.md +9 -0
- data/docs/clickwrap.md +13 -0
- data/docs/clickwrap_acceptance.md +30 -0
- data/docs/client_log.md +17 -0
- data/docs/crash_report.md +50 -0
- data/docs/custom_domain.md +13 -0
- data/docs/custom_domain_for_proxy.md +23 -0
- data/docs/desktop_configuration_profile.md +14 -0
- data/docs/dns_record.md +9 -0
- data/docs/email_incoming_message.md +19 -0
- data/docs/email_log.md +20 -1
- data/docs/email_preference.md +108 -0
- data/docs/email_preference_bundle_notification.md +15 -0
- data/docs/email_preference_notification.md +17 -0
- data/docs/event_channel.md +14 -0
- data/docs/event_delivery_attempt.md +14 -0
- data/docs/event_record.md +19 -0
- data/docs/event_subscription.md +14 -0
- data/docs/event_target.md +14 -0
- data/docs/exavault_api_request_log.md +21 -1
- data/docs/expectation.md +14 -0
- data/docs/expectation_evaluation.md +14 -0
- data/docs/expectation_incident.md +14 -0
- data/docs/export.md +90 -0
- data/docs/external_event.md +18 -0
- data/docs/file.md +90 -2
- data/docs/file_migration.md +32 -0
- data/docs/file_migration_log.md +20 -1
- data/docs/file_upload_part.md +3 -1
- data/docs/folder.md +20 -0
- data/docs/form_field_set.md +15 -0
- data/docs/front_end_server.md +111 -0
- data/docs/frontend_metric.md +34 -0
- data/docs/ftp_action_log.md +21 -1
- data/docs/gpg_key.md +21 -0
- data/docs/group.md +19 -0
- data/docs/group_user.md +22 -2
- data/docs/history.md +85 -0
- data/docs/history_export_result.md +17 -0
- data/docs/holiday_region.md +9 -0
- data/docs/inbound_s3_log.md +21 -1
- data/docs/inbox.md +102 -0
- data/docs/inbox_recipient.md +19 -0
- data/docs/inbox_recipient_registration.md +35 -0
- data/docs/inbox_registration.md +57 -0
- data/docs/inbox_upload.md +18 -0
- data/docs/invoice.md +9 -0
- data/docs/ip.md +63 -0
- data/docs/ip_abuse_entry.md +47 -0
- data/docs/ip_address.md +59 -0
- data/docs/key_lifecycle_rule.md +14 -0
- data/docs/label.md +9 -0
- data/docs/lead.md +161 -0
- data/docs/lock.md +15 -0
- data/docs/message.md +17 -0
- data/docs/message_comment.md +18 -0
- data/docs/message_comment_reaction.md +18 -0
- data/docs/message_reaction.md +17 -0
- data/docs/metadata_category.md +13 -0
- data/docs/monitoring_stat.md +38 -0
- data/docs/monitoring_stats.md +15 -0
- data/docs/mover_package.md +68 -0
- data/docs/notification.md +20 -0
- data/docs/nps_response.md +75 -0
- data/docs/oauth_redirect.md +11 -0
- data/docs/outbound_connection_log.md +21 -1
- data/docs/paired_api_key.md +19 -0
- data/docs/partner.md +14 -0
- data/docs/partner_channel.md +14 -0
- data/docs/partner_site_request.md +14 -0
- data/docs/payment.md +9 -0
- data/docs/paypal_express_info.md +31 -0
- data/docs/paypal_express_url.md +11 -0
- data/docs/pending_work_event.md +18 -0
- data/docs/permission.md +22 -0
- data/docs/plan.md +107 -0
- data/docs/preview.md +57 -0
- data/docs/project.md +9 -0
- data/docs/public_hosting_request_log.md +21 -1
- data/docs/public_hosting_session_pairing.md +15 -0
- data/docs/public_inbox.md +121 -0
- data/docs/public_key.md +21 -0
- data/docs/public_url.md +59 -0
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +83 -0
- data/docs/release_package.md +19 -0
- data/docs/remote_bandwidth_snapshot.md +18 -0
- data/docs/remote_mount_backend.md +13 -0
- data/docs/remote_server.md +233 -0
- data/docs/remote_server_credential.md +15 -0
- data/docs/request.md +17 -0
- data/docs/restore.md +14 -0
- data/docs/revision.md +40 -0
- data/docs/safe_plan.md +0 -0
- data/docs/scheduled_export.md +15 -0
- data/docs/scim_log.md +13 -0
- data/docs/session.md +232 -1
- data/docs/session_available_site.md +26 -0
- data/docs/setting.md +33 -0
- data/docs/settings.md +498 -0
- data/docs/settings_change.md +16 -0
- data/docs/sftp_action_log.md +21 -1
- data/docs/sftp_host_key.md +9 -0
- data/docs/share_group.md +15 -0
- data/docs/siem_http_destination.md +9 -0
- data/docs/siem_http_destination_event.md +18 -0
- data/docs/site.md +179 -0
- data/docs/site_subdomain_redirect.md +13 -0
- data/docs/snapshot.md +9 -0
- data/docs/ssl_certificate.md +37 -0
- data/docs/sso_event.md +19 -0
- data/docs/sso_strategy.md +406 -0
- data/docs/staging_site.md +591 -0
- data/docs/support_request.md +126 -0
- data/docs/sync.md +14 -0
- data/docs/sync_api_usage_snapshot.md +23 -0
- data/docs/sync_api_usage_snapshot_report.md +71 -0
- data/docs/sync_bandwidth_snapshot.md +48 -0
- data/docs/sync_log.md +20 -1
- data/docs/sync_run.md +21 -0
- data/docs/two_factor_authentication_method.md +169 -0
- data/docs/usage_daily_snapshot.md +18 -0
- data/docs/usage_snapshot.md +9 -0
- data/docs/user.md +49 -2
- data/docs/user_cipher_use.md +21 -0
- data/docs/user_lifecycle_rule.md +14 -0
- data/docs/user_request.md +9 -0
- data/docs/user_security_event.md +18 -0
- data/docs/user_sftp_client_use.md +15 -0
- data/docs/warning.md +36 -0
- data/docs/web_dav_action_log.md +21 -1
- data/docs/webauthn_sign_request.md +13 -0
- data/docs/workspace.md +15 -0
- data/docs/zip_download.md +32 -0
- data/docs/zip_download_file.md +45 -0
- data/docs/zip_download_files.md +23 -0
- data/lib/files.com/errors.rb +1 -0
- data/lib/files.com/models/account.rb +346 -0
- data/lib/files.com/models/action_log.rb +24 -0
- data/lib/files.com/models/action_notification_export_result.rb +12 -0
- data/lib/files.com/models/action_webhook_failure.rb +34 -0
- data/lib/files.com/models/agent_proxy_identity.rb +47 -0
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
- data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
- data/lib/files.com/models/agent_v2_auth.rb +32 -0
- data/lib/files.com/models/ai_assistant_personality.rb +11 -0
- data/lib/files.com/models/ai_task.rb +11 -0
- data/lib/files.com/models/announcement.rb +89 -0
- data/lib/files.com/models/api_key.rb +39 -5
- data/lib/files.com/models/api_request_log.rb +24 -0
- data/lib/files.com/models/app.rb +13 -0
- data/lib/files.com/models/as2_incoming_message.rb +19 -0
- data/lib/files.com/models/as2_outgoing_message.rb +19 -0
- data/lib/files.com/models/as2_partner.rb +11 -0
- data/lib/files.com/models/as2_station.rb +11 -0
- data/lib/files.com/models/automation.rb +30 -0
- data/lib/files.com/models/automation_log.rb +24 -0
- data/lib/files.com/models/automation_run.rb +16 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/behavior.rb +11 -0
- data/lib/files.com/models/blog_post.rb +84 -0
- data/lib/files.com/models/bundle.rb +52 -0
- data/lib/files.com/models/bundle_action.rb +25 -0
- data/lib/files.com/models/bundle_download.rb +23 -0
- data/lib/files.com/models/bundle_notification.rb +15 -0
- data/lib/files.com/models/bundle_recipient.rb +27 -0
- data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
- data/lib/files.com/models/bundle_registration.rb +125 -0
- data/lib/files.com/models/certificate.rb +455 -0
- data/lib/files.com/models/chat_session.rb +11 -0
- data/lib/files.com/models/child_site.rb +1756 -0
- data/lib/files.com/models/child_site_management_policy.rb +5 -0
- data/lib/files.com/models/clickwrap.rb +9 -0
- data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
- data/lib/files.com/models/client_log.rb +25 -0
- data/lib/files.com/models/crash_report.rb +151 -0
- data/lib/files.com/models/custom_domain.rb +9 -0
- data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
- data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
- data/lib/files.com/models/dns_record.rb +5 -0
- data/lib/files.com/models/email_incoming_message.rb +21 -0
- data/lib/files.com/models/email_log.rb +22 -0
- data/lib/files.com/models/email_preference.rb +124 -0
- data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
- data/lib/files.com/models/email_preference_notification.rb +32 -0
- data/lib/files.com/models/event_channel.rb +11 -0
- data/lib/files.com/models/event_delivery_attempt.rb +11 -0
- data/lib/files.com/models/event_record.rb +21 -0
- data/lib/files.com/models/event_subscription.rb +11 -0
- data/lib/files.com/models/event_target.rb +11 -0
- data/lib/files.com/models/exavault_api_request_log.rb +24 -0
- data/lib/files.com/models/expectation.rb +11 -0
- data/lib/files.com/models/expectation_evaluation.rb +11 -0
- data/lib/files.com/models/expectation_incident.rb +11 -0
- data/lib/files.com/models/export.rb +153 -0
- data/lib/files.com/models/external_event.rb +19 -0
- data/lib/files.com/models/file.rb +207 -0
- data/lib/files.com/models/file_migration.rb +27 -0
- data/lib/files.com/models/file_migration_log.rb +22 -0
- data/lib/files.com/models/file_upload_part.rb +5 -0
- data/lib/files.com/models/folder.rb +69 -0
- data/lib/files.com/models/form_field_set.rb +9 -0
- data/lib/files.com/models/front_end_server.rb +335 -0
- data/lib/files.com/models/frontend_metric.rb +65 -0
- data/lib/files.com/models/ftp_action_log.rb +24 -0
- data/lib/files.com/models/gpg_key.rb +21 -0
- data/lib/files.com/models/group.rb +16 -0
- data/lib/files.com/models/group_user.rb +21 -1
- data/lib/files.com/models/history.rb +94 -0
- data/lib/files.com/models/history_export_result.rb +12 -0
- data/lib/files.com/models/holiday_region.rb +5 -0
- data/lib/files.com/models/inbound_s3_log.rb +24 -0
- data/lib/files.com/models/inbox.rb +123 -0
- data/lib/files.com/models/inbox_recipient.rb +25 -0
- data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
- data/lib/files.com/models/inbox_registration.rb +121 -0
- data/lib/files.com/models/inbox_upload.rb +19 -0
- data/lib/files.com/models/invoice.rb +5 -0
- data/lib/files.com/models/ip.rb +82 -0
- data/lib/files.com/models/ip_abuse_entry.rb +96 -0
- data/lib/files.com/models/ip_address.rb +37 -0
- data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/label.rb +22 -0
- data/lib/files.com/models/lead.rb +434 -0
- data/lib/files.com/models/lock.rb +27 -0
- data/lib/files.com/models/message.rb +12 -0
- data/lib/files.com/models/message_comment.rb +14 -0
- data/lib/files.com/models/message_comment_reaction.rb +14 -0
- data/lib/files.com/models/message_reaction.rb +12 -0
- data/lib/files.com/models/metadata_category.rb +9 -0
- data/lib/files.com/models/monitoring_stat.rb +43 -0
- data/lib/files.com/models/monitoring_stats.rb +22 -0
- data/lib/files.com/models/mover_package.rb +80 -0
- data/lib/files.com/models/notification.rb +18 -0
- data/lib/files.com/models/nps_response.rb +128 -0
- data/lib/files.com/models/oauth_redirect.rb +17 -0
- data/lib/files.com/models/outbound_connection_log.rb +24 -0
- data/lib/files.com/models/paired_api_key.rb +37 -0
- data/lib/files.com/models/partner.rb +11 -0
- data/lib/files.com/models/partner_channel.rb +11 -0
- data/lib/files.com/models/partner_site_request.rb +11 -0
- data/lib/files.com/models/payment.rb +5 -0
- data/lib/files.com/models/paypal_express_info.rb +67 -0
- data/lib/files.com/models/paypal_express_url.rb +17 -0
- data/lib/files.com/models/pending_work_event.rb +19 -0
- data/lib/files.com/models/permission.rb +22 -0
- data/lib/files.com/models/plan.rb +209 -0
- data/lib/files.com/models/preview.rb +57 -0
- data/lib/files.com/models/project.rb +5 -0
- data/lib/files.com/models/public_hosting_request_log.rb +24 -0
- data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
- data/lib/files.com/models/public_inbox.rb +142 -0
- data/lib/files.com/models/public_key.rb +21 -0
- data/lib/files.com/models/public_url.rb +177 -0
- data/lib/files.com/models/regional_migration.rb +12 -0
- data/lib/files.com/models/release.rb +153 -0
- data/lib/files.com/models/release_package.rb +37 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/remote_mount_backend.rb +9 -0
- data/lib/files.com/models/remote_server.rb +297 -0
- data/lib/files.com/models/remote_server_credential.rb +13 -0
- data/lib/files.com/models/request.rb +12 -0
- data/lib/files.com/models/restore.rb +11 -0
- data/lib/files.com/models/revision.rb +53 -0
- data/lib/files.com/models/safe_plan.rb +12 -0
- data/lib/files.com/models/scheduled_export.rb +13 -0
- data/lib/files.com/models/scim_log.rb +9 -0
- data/lib/files.com/models/session.rb +493 -0
- data/lib/files.com/models/session_available_site.rb +47 -0
- data/lib/files.com/models/setting.rb +36 -0
- data/lib/files.com/models/settings.rb +1072 -0
- data/lib/files.com/models/settings_change.rb +16 -0
- data/lib/files.com/models/sftp_action_log.rb +24 -0
- data/lib/files.com/models/sftp_host_key.rb +5 -0
- data/lib/files.com/models/share_group.rb +9 -0
- data/lib/files.com/models/siem_http_destination.rb +5 -0
- data/lib/files.com/models/siem_http_destination_event.rb +19 -0
- data/lib/files.com/models/site.rb +1021 -0
- data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
- data/lib/files.com/models/snapshot.rb +5 -0
- data/lib/files.com/models/ssl_certificate.rb +77 -0
- data/lib/files.com/models/sso_event.rb +21 -0
- data/lib/files.com/models/sso_strategy.rb +632 -0
- data/lib/files.com/models/staging_site.rb +1781 -0
- data/lib/files.com/models/support_request.rb +209 -0
- data/lib/files.com/models/sync.rb +11 -0
- data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
- data/lib/files.com/models/sync_log.rb +22 -0
- data/lib/files.com/models/sync_run.rb +21 -0
- data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
- data/lib/files.com/models/usage_snapshot.rb +5 -0
- data/lib/files.com/models/user.rb +59 -0
- data/lib/files.com/models/user_cipher_use.rb +21 -0
- data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/user_request.rb +5 -0
- data/lib/files.com/models/user_security_event.rb +19 -0
- data/lib/files.com/models/user_sftp_client_use.rb +9 -0
- data/lib/files.com/models/warning.rb +38 -0
- data/lib/files.com/models/web_dav_action_log.rb +24 -0
- data/lib/files.com/models/webauthn_sign_request.rb +17 -0
- data/lib/files.com/models/workspace.rb +13 -0
- data/lib/files.com/models/zip_download.rb +73 -0
- data/lib/files.com/models/zip_download_file.rb +111 -0
- data/lib/files.com/models/zip_download_files.rb +42 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +59 -0
- metadata +120 -2
|
@@ -0,0 +1,591 @@
|
|
|
1
|
+
# StagingSite
|
|
2
|
+
|
|
3
|
+
## Example StagingSite Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"name": "My Site",
|
|
9
|
+
"additional_text_file_types": [
|
|
10
|
+
"example"
|
|
11
|
+
],
|
|
12
|
+
"ai_feature_availability": {
|
|
13
|
+
"in_app_ai_assistant": {
|
|
14
|
+
"site_admins": true,
|
|
15
|
+
"workspace_admins": true,
|
|
16
|
+
"folder_admins": true,
|
|
17
|
+
"all_users": true
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"allowed_2fa_method_sms": true,
|
|
21
|
+
"allowed_2fa_method_totp": true,
|
|
22
|
+
"allowed_2fa_method_webauthn": true,
|
|
23
|
+
"allowed_2fa_method_yubi": true,
|
|
24
|
+
"allowed_2fa_method_email": true,
|
|
25
|
+
"allowed_2fa_method_static": true,
|
|
26
|
+
"allowed_2fa_method_bypass_for_ftp_sftp_dav": true,
|
|
27
|
+
"admin_user_id": 1,
|
|
28
|
+
"admins_bypass_locked_subfolders": true,
|
|
29
|
+
"allow_bundle_names": true,
|
|
30
|
+
"allow_user_level_2fa_override": true,
|
|
31
|
+
"allow_user_level_allowed_ip_override": true,
|
|
32
|
+
"allow_user_level_ssl_override": true,
|
|
33
|
+
"allowed_countries": "US,DE",
|
|
34
|
+
"allowed_ips": "example",
|
|
35
|
+
"always_mkdir_parents": true,
|
|
36
|
+
"as2_message_retention_days": 1,
|
|
37
|
+
"ask_about_overwrites": true,
|
|
38
|
+
"bundle_activity_notifications": "never",
|
|
39
|
+
"bundle_expiration": 1,
|
|
40
|
+
"bundle_not_found_message": "example",
|
|
41
|
+
"bundle_password_required": true,
|
|
42
|
+
"bundles_default_owned_by_primary_group": true,
|
|
43
|
+
"bundle_recipient_blacklist_domains": [
|
|
44
|
+
"example"
|
|
45
|
+
],
|
|
46
|
+
"bundle_recipient_blacklist_free_email_domains": true,
|
|
47
|
+
"bundle_registration_notifications": "never",
|
|
48
|
+
"bundle_require_registration": true,
|
|
49
|
+
"bundle_require_share_recipient": true,
|
|
50
|
+
"bundle_require_note": true,
|
|
51
|
+
"bundle_send_shared_receipts": true,
|
|
52
|
+
"bundle_upload_receipt_notifications": "never",
|
|
53
|
+
"bundle_watermark_attachment": {
|
|
54
|
+
"name": "My logo",
|
|
55
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
56
|
+
},
|
|
57
|
+
"bundle_watermark_value": {
|
|
58
|
+
"key": "example value"
|
|
59
|
+
},
|
|
60
|
+
"calculate_file_checksums_crc32": true,
|
|
61
|
+
"calculate_file_checksums_md5": true,
|
|
62
|
+
"calculate_file_checksums_sha1": true,
|
|
63
|
+
"calculate_file_checksums_sha256": true,
|
|
64
|
+
"uploads_via_email_authentication": true,
|
|
65
|
+
"color2_left": "#0066a7",
|
|
66
|
+
"color2_link": "#d34f5d",
|
|
67
|
+
"color2_text": "#0066a7",
|
|
68
|
+
"color2_top": "#000000",
|
|
69
|
+
"color2_top_text": "#ffffff",
|
|
70
|
+
"contact_name": "John Doe",
|
|
71
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
72
|
+
"currency": "USD",
|
|
73
|
+
"custom_namespace": true,
|
|
74
|
+
"dav_enabled": true,
|
|
75
|
+
"dav_user_root_enabled": true,
|
|
76
|
+
"days_to_retain_backups": 30,
|
|
77
|
+
"document_edits_in_bundle_allowed": true,
|
|
78
|
+
"default_time_zone": "Pacific Time (US & Canada)",
|
|
79
|
+
"desktop_app": true,
|
|
80
|
+
"desktop_app_session_ip_pinning": true,
|
|
81
|
+
"desktop_app_session_lifetime": 1,
|
|
82
|
+
"legacy_checksums_mode": true,
|
|
83
|
+
"migrate_remote_server_sync_to_sync": true,
|
|
84
|
+
"mcp_dcr_enabled": true,
|
|
85
|
+
"mobile_app": true,
|
|
86
|
+
"mobile_app_session_ip_pinning": true,
|
|
87
|
+
"mobile_app_session_lifetime": 1,
|
|
88
|
+
"disallowed_countries": "US,DE",
|
|
89
|
+
"disable_all_ai_features": true,
|
|
90
|
+
"disable_files_certificate_generation": true,
|
|
91
|
+
"disable_notifications": true,
|
|
92
|
+
"disable_password_reset": true,
|
|
93
|
+
"domain": "my-custom-domain.com",
|
|
94
|
+
"domain_hsts_header": true,
|
|
95
|
+
"domain_letsencrypt_chain": "example",
|
|
96
|
+
"email": "john.doe@files.com",
|
|
97
|
+
"ftp_enabled": true,
|
|
98
|
+
"reply_to_email": "jane.doe@files.com",
|
|
99
|
+
"non_sso_groups_allowed": true,
|
|
100
|
+
"non_sso_users_allowed": true,
|
|
101
|
+
"folder_permissions_groups_only": true,
|
|
102
|
+
"group_admins_can_add_users": true,
|
|
103
|
+
"group_admins_can_delete_users": true,
|
|
104
|
+
"group_admins_can_enable_disable_users": true,
|
|
105
|
+
"group_admins_can_modify_users": true,
|
|
106
|
+
"group_admins_can_bypass_user_lifecycle_rules": true,
|
|
107
|
+
"group_admins_can_reset_passwords": true,
|
|
108
|
+
"group_admins_can_set_user_password": true,
|
|
109
|
+
"hipaa": true,
|
|
110
|
+
"icon128": {
|
|
111
|
+
"name": "My logo",
|
|
112
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
113
|
+
},
|
|
114
|
+
"icon16": {
|
|
115
|
+
"name": "My logo",
|
|
116
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
117
|
+
},
|
|
118
|
+
"icon32": {
|
|
119
|
+
"name": "My logo",
|
|
120
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
121
|
+
},
|
|
122
|
+
"icon48": {
|
|
123
|
+
"name": "My logo",
|
|
124
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
125
|
+
},
|
|
126
|
+
"immutable_files_set_at": "2000-01-01T01:00:00Z",
|
|
127
|
+
"include_password_in_welcome_email": true,
|
|
128
|
+
"language": "en",
|
|
129
|
+
"ldap_base_dn": "example",
|
|
130
|
+
"ldap_domain": "mysite.com",
|
|
131
|
+
"ldap_enabled": true,
|
|
132
|
+
"ldap_group_action": "disabled",
|
|
133
|
+
"ldap_group_exclusion": "example",
|
|
134
|
+
"ldap_group_inclusion": "example",
|
|
135
|
+
"ldap_host": "ldap.site.com",
|
|
136
|
+
"ldap_host_2": "ldap2.site.com",
|
|
137
|
+
"ldap_host_3": "ldap3.site.com",
|
|
138
|
+
"ldap_port": 1,
|
|
139
|
+
"ldap_secure": true,
|
|
140
|
+
"ldap_type": "open_ldap",
|
|
141
|
+
"ldap_user_action": "disabled",
|
|
142
|
+
"ldap_user_include_groups": "example",
|
|
143
|
+
"ldap_username": "[ldap username]",
|
|
144
|
+
"ldap_username_field": "sAMAccountName",
|
|
145
|
+
"login_help_text": "Login page help text.",
|
|
146
|
+
"logo": {
|
|
147
|
+
"name": "My logo",
|
|
148
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
149
|
+
},
|
|
150
|
+
"login_page_background_image": {
|
|
151
|
+
"name": "My logo",
|
|
152
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
153
|
+
},
|
|
154
|
+
"max_prior_passwords": 1,
|
|
155
|
+
"managed_site_settings": "example",
|
|
156
|
+
"motd_text": "example",
|
|
157
|
+
"motd_use_for_ftp": true,
|
|
158
|
+
"motd_use_for_sftp": true,
|
|
159
|
+
"next_billing_amount": "1.0",
|
|
160
|
+
"next_billing_date": "Apr 20",
|
|
161
|
+
"office_integration_available": true,
|
|
162
|
+
"office_integration_type": "example",
|
|
163
|
+
"oncehub_link": "https://go.oncehub.com/files",
|
|
164
|
+
"opt_out_global": true,
|
|
165
|
+
"overdue": true,
|
|
166
|
+
"password_min_length": 1,
|
|
167
|
+
"password_require_letter": true,
|
|
168
|
+
"password_require_mixed": true,
|
|
169
|
+
"password_require_number": true,
|
|
170
|
+
"password_require_special": true,
|
|
171
|
+
"password_require_unbreached": true,
|
|
172
|
+
"password_requirements_apply_to_bundles": true,
|
|
173
|
+
"password_validity_days": 1,
|
|
174
|
+
"phone": "555-555-5555",
|
|
175
|
+
"pin_all_remote_servers_to_site_region": true,
|
|
176
|
+
"prevent_root_permissions_for_non_site_admins": true,
|
|
177
|
+
"protocol_access_groups_only": true,
|
|
178
|
+
"require_2fa": true,
|
|
179
|
+
"require_2fa_exempt_all_sso_users": true,
|
|
180
|
+
"require_2fa_stop_time": "2000-01-01T01:00:00Z",
|
|
181
|
+
"revoke_bundle_access_on_disable_or_delete": true,
|
|
182
|
+
"require_2fa_user_type": "`site_admins`",
|
|
183
|
+
"require_logout_from_bundles_and_inboxes": true,
|
|
184
|
+
"session": {
|
|
185
|
+
"id": "60525f92e859c4c3d74cb02fd176b1525901b525",
|
|
186
|
+
"language": "en",
|
|
187
|
+
"aws_secret_key": "example",
|
|
188
|
+
"ai_assistant_personality_id": 1,
|
|
189
|
+
"ai_assistant_personality_system_prompt": "example",
|
|
190
|
+
"login_token": "@tok-randomcode",
|
|
191
|
+
"login_token_domain": "https://mysite.files.com",
|
|
192
|
+
"default_workspace_id": 1,
|
|
193
|
+
"max_dir_listing_size": 1,
|
|
194
|
+
"multiple_regions": true,
|
|
195
|
+
"read_only": true,
|
|
196
|
+
"root_path": "example",
|
|
197
|
+
"home_path": "example",
|
|
198
|
+
"sftp_insecure_ciphers": false,
|
|
199
|
+
"site_id": 1,
|
|
200
|
+
"ssl_required": true,
|
|
201
|
+
"timeout_at": "2000-01-01T01:00:00Z",
|
|
202
|
+
"trusted": true,
|
|
203
|
+
"two_factor_setup_needed": false,
|
|
204
|
+
"allowed_2fa_method_sms": true,
|
|
205
|
+
"allowed_2fa_method_totp": true,
|
|
206
|
+
"allowed_2fa_method_webauthn": true,
|
|
207
|
+
"allowed_2fa_method_yubi": true,
|
|
208
|
+
"calculate_file_checksums_crc32": true,
|
|
209
|
+
"calculate_file_checksums_md5": true,
|
|
210
|
+
"calculate_file_checksums_sha1": true,
|
|
211
|
+
"calculate_file_checksums_sha256": true,
|
|
212
|
+
"legacy_checksums_mode": true,
|
|
213
|
+
"finalize_partial_uploads": true,
|
|
214
|
+
"use_provided_modified_at": true,
|
|
215
|
+
"windows_mode_ftp": false,
|
|
216
|
+
"user_belongs_to_parent_site": false,
|
|
217
|
+
"impersonator_user_id": 1
|
|
218
|
+
},
|
|
219
|
+
"sftp_enabled": true,
|
|
220
|
+
"sftp_finalize_partial_uploads": true,
|
|
221
|
+
"sftp_host_key_type": "default",
|
|
222
|
+
"active_sftp_host_key_id": 1,
|
|
223
|
+
"sftp_insecure_ciphers": true,
|
|
224
|
+
"sftp_insecure_diffie_hellman": true,
|
|
225
|
+
"sftp_user_root_enabled": true,
|
|
226
|
+
"sharing_enabled": true,
|
|
227
|
+
"show_user_notifications_log_in_link": true,
|
|
228
|
+
"show_request_access_link": true,
|
|
229
|
+
"site_footer": "example",
|
|
230
|
+
"site_header": "example",
|
|
231
|
+
"site_public_footer": "example",
|
|
232
|
+
"site_public_header": "example",
|
|
233
|
+
"smtp_address": "smtp.my-mail-server.com",
|
|
234
|
+
"smtp_authentication": "plain",
|
|
235
|
+
"smtp_from": "me@my-mail-server.com",
|
|
236
|
+
"smtp_port": 25,
|
|
237
|
+
"smtp_username": "mail",
|
|
238
|
+
"session_expiry_minutes": 360,
|
|
239
|
+
"snapshot_sharing_enabled": true,
|
|
240
|
+
"ssl_required": true,
|
|
241
|
+
"subdomain": "mysite",
|
|
242
|
+
"switch_to_plan_date": "2000-01-01T01:00:00Z",
|
|
243
|
+
"trial_days_left": 1,
|
|
244
|
+
"trial_until": "2000-01-01T01:00:00Z",
|
|
245
|
+
"use_dedicated_ips_for_smtp": true,
|
|
246
|
+
"use_provided_modified_at": true,
|
|
247
|
+
"user": {
|
|
248
|
+
"id": 1,
|
|
249
|
+
"username": "user",
|
|
250
|
+
"admin_group_ids": [
|
|
251
|
+
1
|
|
252
|
+
],
|
|
253
|
+
"allowed_ips": "10.0.0.0/8\n127.0.0.1",
|
|
254
|
+
"attachments_permission": true,
|
|
255
|
+
"api_keys_count": 1,
|
|
256
|
+
"authenticate_until": "2000-01-01T01:00:00Z",
|
|
257
|
+
"authentication_method": "password",
|
|
258
|
+
"avatar_url": "example",
|
|
259
|
+
"billable": true,
|
|
260
|
+
"billing_permission": false,
|
|
261
|
+
"bypass_site_allowed_ips": false,
|
|
262
|
+
"bypass_user_lifecycle_rules": false,
|
|
263
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
264
|
+
"dav_permission": true,
|
|
265
|
+
"disabled": true,
|
|
266
|
+
"disabled_expired_or_inactive": true,
|
|
267
|
+
"ai_assistant_personality_id": 1,
|
|
268
|
+
"desktop_configuration_profile_id": 1,
|
|
269
|
+
"email": "john.doe@files.com",
|
|
270
|
+
"filesystem_layout": "site_root",
|
|
271
|
+
"first_login_at": "2000-01-01T01:00:00Z",
|
|
272
|
+
"ftp_permission": true,
|
|
273
|
+
"group_ids": "example",
|
|
274
|
+
"header_text": "User-specific message.",
|
|
275
|
+
"language": "en",
|
|
276
|
+
"last_login_at": "2000-01-01T01:00:00Z",
|
|
277
|
+
"last_web_login_at": "2000-01-01T01:00:00Z",
|
|
278
|
+
"last_ftp_login_at": "2000-01-01T01:00:00Z",
|
|
279
|
+
"last_sftp_login_at": "2000-01-01T01:00:00Z",
|
|
280
|
+
"last_dav_login_at": "2000-01-01T01:00:00Z",
|
|
281
|
+
"last_desktop_login_at": "2000-01-01T01:00:00Z",
|
|
282
|
+
"last_restapi_login_at": "2000-01-01T01:00:00Z",
|
|
283
|
+
"last_api_use_at": "2000-01-01T01:00:00Z",
|
|
284
|
+
"last_active_at": "2000-01-01T01:00:00Z",
|
|
285
|
+
"last_protocol_cipher": "example",
|
|
286
|
+
"lockout_expires": "2000-01-01T01:00:00Z",
|
|
287
|
+
"name": "John Doe",
|
|
288
|
+
"company": "ACME Corp.",
|
|
289
|
+
"notes": "Internal notes on this user.",
|
|
290
|
+
"notification_daily_send_time": 18,
|
|
291
|
+
"office_integration_enabled": true,
|
|
292
|
+
"partner_admin": true,
|
|
293
|
+
"partner_id": 1,
|
|
294
|
+
"partner_name": "example",
|
|
295
|
+
"password_set_at": "2000-01-01T01:00:00Z",
|
|
296
|
+
"password_validity_days": 1,
|
|
297
|
+
"primary_group_id": 1,
|
|
298
|
+
"public_keys_count": 1,
|
|
299
|
+
"receive_admin_alerts": true,
|
|
300
|
+
"notify_on_all_site_warnings": true,
|
|
301
|
+
"notify_on_all_sso_failures": true,
|
|
302
|
+
"notify_on_all_user_security_events": true,
|
|
303
|
+
"notify_on_all_pending_work_failures": true,
|
|
304
|
+
"notify_on_all_siem_http_destination_failures": true,
|
|
305
|
+
"notify_on_all_sync_failures": true,
|
|
306
|
+
"notify_on_all_automation_failures": true,
|
|
307
|
+
"notify_on_all_expectation_failures": true,
|
|
308
|
+
"require_2fa": "always_require",
|
|
309
|
+
"require_login_by": "2000-01-01T01:00:00Z",
|
|
310
|
+
"active_2fa": true,
|
|
311
|
+
"require_password_change": true,
|
|
312
|
+
"password_expired": true,
|
|
313
|
+
"readonly_site_admin": true,
|
|
314
|
+
"restapi_permission": true,
|
|
315
|
+
"self_managed": true,
|
|
316
|
+
"sftp_permission": true,
|
|
317
|
+
"site_admin": true,
|
|
318
|
+
"workspace_admin": true,
|
|
319
|
+
"site_id": 1,
|
|
320
|
+
"workspace_id": 1,
|
|
321
|
+
"default_workspace_id": 1,
|
|
322
|
+
"skip_welcome_screen": true,
|
|
323
|
+
"ssl_required": "always_require",
|
|
324
|
+
"sso_strategy_id": 1,
|
|
325
|
+
"subscribe_to_newsletter": true,
|
|
326
|
+
"externally_managed": true,
|
|
327
|
+
"tags": "example",
|
|
328
|
+
"time_zone": "Pacific Time (US & Canada)",
|
|
329
|
+
"type_of_2fa": "yubi",
|
|
330
|
+
"type_of_2fa_for_display": "yubi",
|
|
331
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
|
332
|
+
"user_root": "example",
|
|
333
|
+
"user_home": "example",
|
|
334
|
+
"days_remaining_until_password_expire": 1,
|
|
335
|
+
"password_expire_at": "2000-01-01T01:00:00Z",
|
|
336
|
+
"has_reassignable_associations": true
|
|
337
|
+
},
|
|
338
|
+
"user_lockout": true,
|
|
339
|
+
"user_lockout_lock_period": 1,
|
|
340
|
+
"user_lockout_tries": 1,
|
|
341
|
+
"user_lockout_within": 6,
|
|
342
|
+
"user_requests_enabled": true,
|
|
343
|
+
"user_requests_notify_admins": true,
|
|
344
|
+
"users_can_create_api_keys": true,
|
|
345
|
+
"users_can_create_ssh_keys": true,
|
|
346
|
+
"username_display": "username_only",
|
|
347
|
+
"welcome_custom_text": "Welcome to my site!",
|
|
348
|
+
"email_footer_custom_text": "Copyright © %Y MyCompany Inc.",
|
|
349
|
+
"welcome_email_cc": "example",
|
|
350
|
+
"welcome_email_subject": "example",
|
|
351
|
+
"welcome_email_enabled": true,
|
|
352
|
+
"welcome_screen": "user_controlled",
|
|
353
|
+
"windows_mode_ftp": true
|
|
354
|
+
}
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
* `id` (int64): Site Id
|
|
358
|
+
* `name` (string): Site name
|
|
359
|
+
* `additional_text_file_types` (array(string)): Additional extensions that are considered text files
|
|
360
|
+
* `ai_feature_availability` (object): Availability settings for AI features by user class
|
|
361
|
+
* `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
|
|
362
|
+
* `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
|
|
363
|
+
* `allowed_2fa_method_webauthn` (boolean): Is WebAuthn two factor authentication allowed?
|
|
364
|
+
* `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
|
|
365
|
+
* `allowed_2fa_method_email` (boolean): Is OTP via email two factor authentication allowed?
|
|
366
|
+
* `allowed_2fa_method_static` (boolean): Is OTP via static codes for two factor authentication allowed?
|
|
367
|
+
* `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?
|
|
368
|
+
* `admin_user_id` (int64): User ID for the main site administrator
|
|
369
|
+
* `admins_bypass_locked_subfolders` (boolean): Allow admins to bypass the locked subfolders setting.
|
|
370
|
+
* `allow_bundle_names` (boolean): Are manual Bundle names allowed?
|
|
371
|
+
* `allow_user_level_2fa_override` (boolean): Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
|
|
372
|
+
* `allow_user_level_allowed_ip_override` (boolean): Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
|
|
373
|
+
* `allow_user_level_ssl_override` (boolean): Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
|
|
374
|
+
* `allowed_countries` (string): Comma separated list of allowed Country codes
|
|
375
|
+
* `allowed_ips` (string): List of allowed IP addresses
|
|
376
|
+
* `always_mkdir_parents` (boolean): Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
|
|
377
|
+
* `as2_message_retention_days` (int64): Number of days to retain AS2 messages (incoming and outgoing).
|
|
378
|
+
* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
|
379
|
+
* `bundle_activity_notifications` (string): Do Bundle owners receive activity notifications?
|
|
380
|
+
* `bundle_expiration` (int64): Site-wide Bundle expiration in days
|
|
381
|
+
* `bundle_not_found_message` (string): Custom error message to show when bundle is not found.
|
|
382
|
+
* `bundle_password_required` (boolean): Do Bundles require password protection?
|
|
383
|
+
* `bundles_default_owned_by_primary_group` (boolean): If true, new Share Links created by a user with a primary group will default to that group as owner.
|
|
384
|
+
* `bundle_recipient_blacklist_domains` (array(string)): List of email domains to disallow when entering a Bundle/Inbox recipients
|
|
385
|
+
* `bundle_recipient_blacklist_free_email_domains` (boolean): Disallow free email domains for Bundle/Inbox recipients?
|
|
386
|
+
* `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
|
|
387
|
+
* `bundle_require_registration` (boolean): Do Bundles require registration?
|
|
388
|
+
* `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
|
|
389
|
+
* `bundle_require_note` (boolean): Do Bundles require internal notes?
|
|
390
|
+
* `bundle_send_shared_receipts` (boolean): Do Bundle creators receive receipts of invitations?
|
|
391
|
+
* `bundle_upload_receipt_notifications` (string): Do Bundle uploaders receive upload confirmation notifications?
|
|
392
|
+
* `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
|
393
|
+
* `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
|
394
|
+
* `calculate_file_checksums_crc32` (boolean): Calculate CRC32 checksums for files?
|
|
395
|
+
* `calculate_file_checksums_md5` (boolean): Calculate MD5 checksums for files?
|
|
396
|
+
* `calculate_file_checksums_sha1` (boolean): Calculate SHA1 checksums for files?
|
|
397
|
+
* `calculate_file_checksums_sha256` (boolean): Calculate SHA256 checksums for files?
|
|
398
|
+
* `uploads_via_email_authentication` (boolean): Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
|
|
399
|
+
* `color2_left` (string): Page link and button color
|
|
400
|
+
* `color2_link` (string): Top bar link color
|
|
401
|
+
* `color2_text` (string): Page link and button color
|
|
402
|
+
* `color2_top` (string): Top bar background color
|
|
403
|
+
* `color2_top_text` (string): Top bar text color
|
|
404
|
+
* `contact_name` (string): Site main contact name
|
|
405
|
+
* `created_at` (date-time): Time this site was created
|
|
406
|
+
* `currency` (string): Preferred currency
|
|
407
|
+
* `custom_namespace` (boolean): Is this site using a custom namespace for users?
|
|
408
|
+
* `dav_enabled` (boolean): Is WebDAV enabled?
|
|
409
|
+
* `dav_user_root_enabled` (boolean): Use user FTP roots also for WebDAV?
|
|
410
|
+
* `days_to_retain_backups` (int64): Number of days to keep deleted files
|
|
411
|
+
* `document_edits_in_bundle_allowed` (boolean): If true, allow public viewers of Bundles with full permissions to use document editing integrations.
|
|
412
|
+
* `default_time_zone` (string): Site default time zone
|
|
413
|
+
* `desktop_app` (boolean): Is the desktop app enabled?
|
|
414
|
+
* `desktop_app_session_ip_pinning` (boolean): Is desktop app session IP pinning enabled?
|
|
415
|
+
* `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
|
|
416
|
+
* `legacy_checksums_mode` (boolean): Use legacy checksums mode?
|
|
417
|
+
* `migrate_remote_server_sync_to_sync` (boolean): If true, we will migrate all remote server syncs to the new Sync model.
|
|
418
|
+
* `mcp_dcr_enabled` (boolean): Is OAuth DCR (dynamic client registration) for MCP enabled?
|
|
419
|
+
* `mobile_app` (boolean): Is the mobile app enabled?
|
|
420
|
+
* `mobile_app_session_ip_pinning` (boolean): Is mobile app session IP pinning enabled?
|
|
421
|
+
* `mobile_app_session_lifetime` (int64): Mobile app session lifetime (in hours)
|
|
422
|
+
* `disallowed_countries` (string): Comma separated list of disallowed Country codes
|
|
423
|
+
* `disable_all_ai_features` (boolean): If true, all AI features are disabled for this site.
|
|
424
|
+
* `disable_files_certificate_generation` (boolean): If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
|
|
425
|
+
* `disable_notifications` (boolean): Are notifications disabled?
|
|
426
|
+
* `disable_password_reset` (boolean): Is password reset disabled?
|
|
427
|
+
* `domain` (string): Custom domain
|
|
428
|
+
* `domain_hsts_header` (boolean): Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
|
|
429
|
+
* `domain_letsencrypt_chain` (string): Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
|
|
430
|
+
* `email` (email): Main email for this site
|
|
431
|
+
* `ftp_enabled` (boolean): Is FTP enabled?
|
|
432
|
+
* `reply_to_email` (email): Reply-to email for this site
|
|
433
|
+
* `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.
|
|
434
|
+
* `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.
|
|
435
|
+
* `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user).
|
|
436
|
+
* `group_admins_can_add_users` (boolean): Allow group admins to create users in their groups
|
|
437
|
+
* `group_admins_can_delete_users` (boolean): Allow group admins to delete users in their groups
|
|
438
|
+
* `group_admins_can_enable_disable_users` (boolean): Allow group admins to enable or disable users in their groups
|
|
439
|
+
* `group_admins_can_modify_users` (boolean): Allow group admins to modify users in their groups
|
|
440
|
+
* `group_admins_can_bypass_user_lifecycle_rules` (boolean): Allow group admins to exempt users in their groups from lifecycle rules
|
|
441
|
+
* `group_admins_can_reset_passwords` (boolean): Allow group admins to reset passwords for users in their groups
|
|
442
|
+
* `group_admins_can_set_user_password` (boolean): Allow group admins to set password authentication method
|
|
443
|
+
* `hipaa` (boolean): Is there a signed HIPAA BAA between Files.com and this site?
|
|
444
|
+
* `icon128` (Image): Branded icon 128x128
|
|
445
|
+
* `icon16` (Image): Branded icon 16x16
|
|
446
|
+
* `icon32` (Image): Branded icon 32x32
|
|
447
|
+
* `icon48` (Image): Branded icon 48x48
|
|
448
|
+
* `immutable_files_set_at` (date-time): Can files be modified?
|
|
449
|
+
* `include_password_in_welcome_email` (boolean): Include password in emails to new users?
|
|
450
|
+
* `language` (string): Site default language
|
|
451
|
+
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
452
|
+
* `ldap_domain` (string): Domain name that will be appended to usernames
|
|
453
|
+
* `ldap_enabled` (boolean): Main LDAP setting: is LDAP enabled?
|
|
454
|
+
* `ldap_group_action` (string): Should we sync groups from LDAP server?
|
|
455
|
+
* `ldap_group_exclusion` (string): Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
|
|
456
|
+
* `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
|
|
457
|
+
* `ldap_host` (string): LDAP host
|
|
458
|
+
* `ldap_host_2` (string): LDAP backup host
|
|
459
|
+
* `ldap_host_3` (string): LDAP backup host
|
|
460
|
+
* `ldap_port` (int64): LDAP port
|
|
461
|
+
* `ldap_secure` (boolean): Use secure LDAP?
|
|
462
|
+
* `ldap_type` (string): LDAP type
|
|
463
|
+
* `ldap_user_action` (string): Should we sync users from LDAP server?
|
|
464
|
+
* `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.
|
|
465
|
+
* `ldap_username` (string): Username for signing in to LDAP server.
|
|
466
|
+
* `ldap_username_field` (string): LDAP username field
|
|
467
|
+
* `login_help_text` (string): Login help text
|
|
468
|
+
* `logo` (Image): Branded logo
|
|
469
|
+
* `login_page_background_image` (Image): Branded login page background
|
|
470
|
+
* `max_prior_passwords` (int64): Number of prior passwords to disallow
|
|
471
|
+
* `managed_site_settings` (object): List of site settings managed by the parent site
|
|
472
|
+
* `motd_text` (string): A message to show users when they connect via FTP or SFTP.
|
|
473
|
+
* `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
|
|
474
|
+
* `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
|
|
475
|
+
* `next_billing_amount` (decimal): Next billing amount
|
|
476
|
+
* `next_billing_date` (string): Next billing date
|
|
477
|
+
* `office_integration_available` (boolean): If true, allows users to use a document editing integration.
|
|
478
|
+
* `office_integration_type` (string): Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
|
|
479
|
+
* `oncehub_link` (string): Link to scheduling a meeting with our Sales team
|
|
480
|
+
* `opt_out_global` (boolean): Use servers in the USA only?
|
|
481
|
+
* `overdue` (boolean): Is this site's billing overdue?
|
|
482
|
+
* `password_min_length` (int64): Shortest password length for users
|
|
483
|
+
* `password_require_letter` (boolean): Require a letter in passwords?
|
|
484
|
+
* `password_require_mixed` (boolean): Require lower and upper case letters in passwords?
|
|
485
|
+
* `password_require_number` (boolean): Require a number in passwords?
|
|
486
|
+
* `password_require_special` (boolean): Require special characters in password?
|
|
487
|
+
* `password_require_unbreached` (boolean): Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
|
|
488
|
+
* `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?
|
|
489
|
+
* `password_validity_days` (int64): Number of days password is valid
|
|
490
|
+
* `phone` (string): Site phone number
|
|
491
|
+
* `pin_all_remote_servers_to_site_region` (boolean): If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
|
|
492
|
+
* `prevent_root_permissions_for_non_site_admins` (boolean): If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
|
|
493
|
+
* `protocol_access_groups_only` (boolean): If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
|
|
494
|
+
* `require_2fa` (boolean): Require two-factor authentication for all users?
|
|
495
|
+
* `require_2fa_exempt_all_sso_users` (boolean): If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
|
|
496
|
+
* `require_2fa_stop_time` (date-time): If set, requirement for two-factor authentication has been scheduled to end on this date-time.
|
|
497
|
+
* `revoke_bundle_access_on_disable_or_delete` (boolean): Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
|
|
498
|
+
* `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)?
|
|
499
|
+
* `require_logout_from_bundles_and_inboxes` (boolean): If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
|
|
500
|
+
* `session` (Session): Current session
|
|
501
|
+
* `sftp_enabled` (boolean): Is SFTP enabled?
|
|
502
|
+
* `sftp_finalize_partial_uploads` (boolean): Finalize partial SFTP uploads from interrupted connections? Default: true.
|
|
503
|
+
* `sftp_host_key_type` (string): Sftp Host Key Type
|
|
504
|
+
* `active_sftp_host_key_id` (int64): Id of the currently selected custom SFTP Host Key
|
|
505
|
+
* `sftp_insecure_ciphers` (boolean): If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
|
|
506
|
+
* `sftp_insecure_diffie_hellman` (boolean): If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full `sftp_insecure_ciphers` option.
|
|
507
|
+
* `sftp_user_root_enabled` (boolean): Use user FTP roots also for SFTP?
|
|
508
|
+
* `sharing_enabled` (boolean): Allow bundle creation
|
|
509
|
+
* `show_user_notifications_log_in_link` (boolean): Show log in link in user notifications?
|
|
510
|
+
* `show_request_access_link` (boolean): Show request access link for users without access? Currently unused.
|
|
511
|
+
* `site_footer` (string): Custom site footer text for authenticated pages
|
|
512
|
+
* `site_header` (string): Custom site header text for authenticated pages
|
|
513
|
+
* `site_public_footer` (string): Custom site footer text for public pages
|
|
514
|
+
* `site_public_header` (string): Custom site header text for public pages
|
|
515
|
+
* `smtp_address` (string): SMTP server hostname or IP
|
|
516
|
+
* `smtp_authentication` (string): SMTP server authentication type
|
|
517
|
+
* `smtp_from` (string): From address to use when mailing through custom SMTP
|
|
518
|
+
* `smtp_port` (int64): SMTP server port
|
|
519
|
+
* `smtp_username` (string): SMTP server username
|
|
520
|
+
* `session_expiry_minutes` (int64): Session expiry in minutes
|
|
521
|
+
* `snapshot_sharing_enabled` (boolean): Allow snapshot share links creation
|
|
522
|
+
* `ssl_required` (boolean): Is SSL required? Disabling this is insecure.
|
|
523
|
+
* `subdomain` (string): Site subdomain
|
|
524
|
+
* `switch_to_plan_date` (date-time): If switching plans, when does the new plan take effect?
|
|
525
|
+
* `trial_days_left` (int64): Number of days left in trial
|
|
526
|
+
* `trial_until` (date-time): When does this Site trial expire?
|
|
527
|
+
* `use_dedicated_ips_for_smtp` (boolean): If using custom SMTP, should we use dedicated IPs to deliver emails?
|
|
528
|
+
* `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?
|
|
529
|
+
* `user` (User): User of current session
|
|
530
|
+
* `user_lockout` (boolean): Will users be locked out after incorrect login attempts?
|
|
531
|
+
* `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
|
|
532
|
+
* `user_lockout_tries` (int64): Number of login tries within `user_lockout_within` hours before users are locked out
|
|
533
|
+
* `user_lockout_within` (int64): Number of hours for user lockout window
|
|
534
|
+
* `user_requests_enabled` (boolean): Enable User Requests feature
|
|
535
|
+
* `user_requests_notify_admins` (boolean): Send email to site admins when a user request is received?
|
|
536
|
+
* `users_can_create_api_keys` (boolean): Allow users to create their own API keys?
|
|
537
|
+
* `users_can_create_ssh_keys` (boolean): Allow users to create their own SSH keys?
|
|
538
|
+
* `username_display` (string): How usernames are displayed in the web UI. Can be `username_only`, `full_name_only`, `full_name_username`, `full_name_company`, or `full_name_username_company`.
|
|
539
|
+
* `welcome_custom_text` (string): Custom text send in user welcome email
|
|
540
|
+
* `email_footer_custom_text` (string): Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
|
|
541
|
+
* `welcome_email_cc` (email): Include this email in welcome emails if enabled
|
|
542
|
+
* `welcome_email_subject` (string): Include this email subject in welcome emails if enabled
|
|
543
|
+
* `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
|
|
544
|
+
* `welcome_screen` (string): Does the welcome screen appear?
|
|
545
|
+
* `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
|
|
546
|
+
* `username` (string):
|
|
547
|
+
* `password` (string):
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
---
|
|
551
|
+
|
|
552
|
+
## List Staging Sites
|
|
553
|
+
|
|
554
|
+
```
|
|
555
|
+
Files::StagingSite.list
|
|
556
|
+
```
|
|
557
|
+
|
|
558
|
+
### Parameters
|
|
559
|
+
|
|
560
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
561
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
---
|
|
565
|
+
|
|
566
|
+
## Create Staging Site
|
|
567
|
+
|
|
568
|
+
```
|
|
569
|
+
Files::StagingSite.create(
|
|
570
|
+
name: "Action Verb",
|
|
571
|
+
email: "johndoe@gmail.com",
|
|
572
|
+
username: "MyUsername",
|
|
573
|
+
password: "MyNewPassword101"
|
|
574
|
+
)
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
### Parameters
|
|
578
|
+
|
|
579
|
+
* `name` (string): Required -
|
|
580
|
+
* `email` (string): Required -
|
|
581
|
+
* `username` (string):
|
|
582
|
+
* `password` (string):
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
---
|
|
586
|
+
|
|
587
|
+
## Create an export CSV of Staging Site resources
|
|
588
|
+
|
|
589
|
+
```
|
|
590
|
+
Files::StagingSite.create_export
|
|
591
|
+
```
|