Sites
A Site is the place you'll come to update site settings, as well as manage site-wide API keys.
Most site settings can be set via the API.
Resource Schema
Import
Sites cannot be created or deleted. They must be imported into the state.
Optional
| Property | Description |
|---|---|
| name String | Site name |
| additional_text_file_types List | Additional extensions that are considered text files |
| ai_feature_availability Dynamic | Availability settings for AI features by user class |
| allowed_2fa_method_sms Bool | Is SMS two factor authentication allowed? |
| allowed_2fa_method_totp Bool | Is TOTP two factor authentication allowed? |
| allowed_2fa_method_webauthn Bool | Is WebAuthn two factor authentication allowed? |
| allowed_2fa_method_yubi Bool | Is yubikey two factor authentication allowed? |
| allowed_2fa_method_email Bool | Is OTP via email two factor authentication allowed? |
| allowed_2fa_method_static Bool | Is OTP via static codes for two factor authentication allowed? |
| allowed_2fa_method_bypass_for_ftp_sftp_dav Bool | Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV? |
| admins_bypass_locked_subfolders Bool | Allow admins to bypass the locked subfolders setting. |
| allow_bundle_names Bool | Are manual Bundle names allowed? |
| allow_user_level_2fa_override Bool | Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis? |
| allow_user_level_allowed_ip_override Bool | Allow the site-wide allowed IP restriction to be overriden on a per-user-basis? |
| allow_user_level_ssl_override Bool | Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis? |
| allowed_countries String | Comma separated list of allowed Country codes |
| allowed_ips String | List of allowed IP addresses |
| always_mkdir_parents Bool | 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. |
| as2_message_retention_days Int64 | Number of days to retain AS2 messages (incoming and outgoing). |
| ask_about_overwrites Bool | If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface. |
| bundle_activity_notifications String | Do Bundle owners receive activity notifications? Possible values: never, always, per_bundle_setting |
| bundle_expiration Int64 | Site-wide Bundle expiration in days |
| bundle_not_found_message String | Custom error message to show when bundle is not found. |
| bundle_password_required Bool | Do Bundles require password protection? |
| bundles_default_owned_by_primary_group Bool | If true, new Share Links created by a user with a primary group will default to that group as owner. |
| bundle_recipient_blacklist_domains List | List of email domains to disallow when entering a Bundle/Inbox recipients |
| bundle_recipient_blacklist_free_email_domains Bool | Disallow free email domains for Bundle/Inbox recipients? |
| bundle_registration_notifications String | Do Bundle owners receive registration notification? Possible values: never, always, per_bundle_setting |
| bundle_require_registration Bool | Do Bundles require registration? |
| bundle_require_share_recipient Bool | Do Bundles require recipients for sharing? |
| bundle_send_one_time_password_to_recipient_at_registration Bool | If true, new Share Links must send a one-time password to the recipient when they register. Requires bundle_require_share_recipient and cannot be enabled with bundle_password_required. |
| bundle_require_note Bool | Do Bundles require internal notes? |
| bundle_send_shared_receipts Bool | Do Bundle creators receive receipts of invitations? |
| bundle_upload_receipt_notifications String | Do Bundle uploaders receive upload confirmation notifications? Possible values: never, always, per_bundle_setting |
| bundle_watermark_value Dynamic | Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value |
| calculate_file_checksums_crc32 Bool | Calculate CRC32 checksums for files? |
| calculate_file_checksums_md5 Bool | Calculate MD5 checksums for files? |
| calculate_file_checksums_sha1 Bool | Calculate SHA1 checksums for files? |
| calculate_file_checksums_sha256 Bool | Calculate SHA256 checksums for files? |
| uploads_via_email_authentication Bool | Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC? |
| color2_left String | Page link and button color |
| color2_link String | Top bar link color |
| color2_text String | Page link and button color |
| color2_top String | Top bar background color |
| color2_top_text String | Top bar text color |
| custom_namespace Bool | Is this site using a custom namespace for users? |
| dav_enabled Bool | Is WebDAV enabled? |
| dav_user_root_enabled Bool | Use user FTP roots also for WebDAV? |
| days_to_retain_backups Int64 | Number of days to keep deleted files |
| document_edits_in_bundle_allowed Bool | If true, allow public viewers of Bundles with full permissions to use document editing integrations. |
| default_time_zone String | Site default time zone |
| desktop_app Bool | Is the desktop app enabled? |
| desktop_app_session_ip_pinning Bool | Is desktop app session IP pinning enabled? |
| desktop_app_session_lifetime Int64 | Desktop app session lifetime (in hours) |
| legacy_checksums_mode Bool | Use legacy checksums mode? |
| migrate_remote_server_sync_to_sync Bool | If true, we will migrate all remote server syncs to the new Sync model. |
| mcp_dcr_enabled Bool | Is OAuth DCR (dynamic client registration) for MCP enabled? |
| mobile_app Bool | Is the mobile app enabled? |
| mobile_app_session_ip_pinning Bool | Is mobile app session IP pinning enabled? |
| mobile_app_session_lifetime Int64 | Mobile app session lifetime (in hours) |
| disallowed_countries String | Comma separated list of disallowed Country codes |
| disable_all_ai_features Bool | If true, all AI features are disabled for this site. |
| disable_files_certificate_generation Bool | If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain. |
| disable_password_reset Bool | Is password reset disabled? |
| domain String | Custom domain |
| domain_hsts_header Bool | Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain? |
| domain_letsencrypt_chain String | Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026. Possible values: default, isrg_root_x1, dst_root_ca_x3 |
| email String | Main email for this site |
| fedramp Bool | Are FedRAMP security restrictions enabled for this site? |
| ftp_enabled Bool | Is FTP enabled? |
| reply_to_email String | Reply-to email for this site |
| non_sso_groups_allowed Bool | If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider. |
| non_sso_users_allowed Bool | If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider. |
| folder_permissions_groups_only Bool | If true, permissions for this site must be bound to a group (not a user). |
| group_admins_can_add_users Bool | Allow group admins to create users in their groups |
| group_admins_can_manage_group_memberships Bool | Allow group admins to add or remove existing users in their groups |
| group_admins_can_delete_users Bool | Allow group admins to delete users in their groups |
| group_admins_can_enable_disable_users Bool | Allow group admins to enable or disable users in their groups |
| group_admins_can_modify_users Bool | Allow group admins to modify users in their groups |
| group_admins_can_bypass_user_lifecycle_rules Bool | Allow group admins to exempt users in their groups from lifecycle rules |
| group_admins_can_reset_passwords Bool | Allow group admins to reset passwords for users in their groups |
| group_admins_can_set_user_password Bool | Allow group admins to set password authentication method |
| include_password_in_welcome_email Bool | Include password in emails to new users? |
| language String | Site default language |
| ldap_base_dn String | Base DN for looking up users in LDAP server |
| ldap_domain String | Domain name that will be appended to usernames |
| ldap_enabled Bool | Main LDAP setting: is LDAP enabled? |
| ldap_group_action String | Should we sync groups from LDAP server? |
| ldap_group_exclusion String | Comma or newline separated list of group names (with optional wildcards) to exclude when syncing. |
| ldap_group_inclusion String | Comma or newline separated list of group names (with optional wildcards) to include when syncing. |
| ldap_host String | LDAP host |
| ldap_host_2 String | LDAP backup host |
| ldap_host_3 String | LDAP backup host |
| ldap_port Int64 | LDAP port |
| ldap_secure Bool | Use secure LDAP? |
| ldap_type String | LDAP type |
| ldap_user_action String | Should we sync users from LDAP server? |
| 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. |
| ldap_username String | Username for signing in to LDAP server. |
| ldap_username_field String | LDAP username field |
| login_help_text String | Login help text |
| max_prior_passwords Int64 | Number of prior passwords to disallow |
| motd_text String | A message to show users when they connect via FTP or SFTP. |
| motd_use_for_ftp Bool | Show message to users connecting via FTP |
| motd_use_for_sftp Bool | Show message to users connecting via SFTP |
| office_integration_available Bool | If true, allows users to use a document editing integration. |
| office_integration_type String | Which document editing integration to support. Files.com Editor or Microsoft Office for the Web. Possible values: only_office, office_365, disabled |
| opt_out_global Bool | Use servers in the USA only? |
| password_min_length Int64 | Shortest password length for users |
| password_require_letter Bool | Require a letter in passwords? |
| password_require_mixed Bool | Require lower and upper case letters in passwords? |
| password_require_number Bool | Require a number in passwords? |
| password_require_special Bool | Require special characters in password? |
| password_require_unbreached Bool | Require passwords that have not been previously breached? (see https://haveibeenpwned.com/) |
| password_requirements_apply_to_bundles Bool | Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords? |
| password_validity_days Int64 | Number of days password is valid |
| pin_all_remote_servers_to_site_region Bool | 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. |
| prevent_root_permissions_for_non_site_admins Bool | 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. |
| protocol_access_groups_only Bool | 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. |
| require_2fa Bool | Require two-factor authentication for all users? |
| restrict_root_folder_behaviors_to_site_admins Bool | If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one. |
| root_folder_behaviors_apply_to_workspaces Bool | If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrict_root_folder_behaviors_to_site_admins to be enabled. |
| require_2fa_exempt_all_sso_users Bool | If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement. |
| revoke_bundle_access_on_disable_or_delete Bool | Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period. |
| 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)?Possible values: all, folder_and_site_admins, site_admins |
| require_logout_from_bundles_and_inboxes Bool | 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. |
| sftp_enabled Bool | Is SFTP enabled? |
| sftp_finalize_partial_uploads Bool | Finalize partial SFTP uploads from interrupted connections? Default: true. |
| sftp_host_key_type String | Sftp Host Key Type Possible values: default, exavault, custom, smartfile |
| active_sftp_host_key_id Int64 | Id of the currently selected custom SFTP Host Key |
| active_sftp_host_key_ids List | Ids of the selected custom SFTP Host Keys |
| sftp_insecure_ciphers Bool | 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. |
| sftp_insecure_diffie_hellman Bool | 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. |
| sftp_user_root_enabled Bool | Use user FTP roots also for SFTP? |
| sharing_enabled Bool | Allow bundle creation |
| show_user_notifications_log_in_link Bool | Show log in link in user notifications? |
| show_request_access_link Bool | Show request access link for users without access? Currently unused. |
| site_footer String | Custom site footer text for authenticated pages |
| site_header String | Custom site header text for authenticated pages |
| site_public_footer String | Custom site footer text for public pages |
| site_public_header String | Custom site header text for public pages |
| smtp_address String | SMTP server hostname or IP |
| smtp_authentication String | SMTP server authentication type |
| smtp_from String | From address to use when mailing through custom SMTP |
| smtp_port Int64 | SMTP server port |
| smtp_username String | SMTP server username |
| session_expiry_minutes Int64 | Session expiry in minutes |
| snapshot_sharing_enabled Bool | Allow snapshot share links creation |
| ssl_required Bool | Is SSL required? Disabling this is insecure. |
| subdomain String | Site subdomain |
| use_dedicated_ips_for_smtp Bool | If using custom SMTP, should we use dedicated IPs to deliver emails? |
| use_provided_modified_at Bool | Allow uploaders to set provided_modified_at for uploaded files? |
| user_lockout Bool | Will users be locked out after incorrect login attempts? |
| user_lockout_lock_period Int64 | How many hours to lock user out for failed password? |
| user_lockout_tries Int64 | Number of login tries within user_lockout_within hours before users are locked out |
| user_lockout_within Int64 | Number of hours for user lockout window |
| user_requests_enabled Bool | Enable User Requests feature |
| user_requests_notify_admins Bool | Send email to site admins when a user request is received? |
| users_can_create_api_keys Bool | Allow users to create their own API keys? |
| users_can_create_ssh_keys Bool | Allow users to create their own SSH keys? |
| 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.Possible values: username_only, full_name_only, full_name_username, full_name_company, full_name_username_company |
| welcome_custom_text String | Custom text send in user welcome email |
| 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). |
| welcome_email_cc String | Include this email in welcome emails if enabled |
| welcome_email_subject String | Include this email subject in welcome emails if enabled |
| welcome_email_enabled Bool | Will the welcome email be sent to new users? |
| welcome_screen String | Does the welcome screen appear? Possible values: enabled, hidden, disabled |
| windows_mode_ftp Bool | Does FTP user Windows emulation mode? |
Read Only
| Property | Description |
|---|---|
| id Int64 | Site Id |
| admin_user_id Int64 | User ID for the main site administrator |
| bundle_watermark_attachment String | Preview watermark image applied to all bundle items. |
| contact_name String | Site main contact name |
| created_at String | Time this site was created |
| currency String | Preferred currency |
| disable_notifications Bool | Are notifications disabled? |
| hipaa Bool | Is there a signed HIPAA BAA between Files.com and this site? |
| icon128 String | Branded icon 128x128 |
| icon16 String | Branded icon 16x16 |
| icon32 String | Branded icon 32x32 |
| icon48 String | Branded icon 48x48 |
| immutable_files_set_at String | Can files be modified? |
| logo String | Branded logo |
| login_page_background_image String | Branded login page background |
| managed_site_settings Dynamic | List of site settings managed by the parent site |
| next_billing_amount String | Next billing amount |
| next_billing_date String | Next billing date |
| oncehub_link String | Link to scheduling a meeting with our Sales team |
| overdue Bool | Is this site's billing overdue? |
| phone String | Site phone number |
| require_2fa_stop_time String | If set, requirement for two-factor authentication has been scheduled to end on this date-time. |
| session String | Current session |
| switch_to_plan_date String | If switching plans, when does the new plan take effect? |
| trial_days_left Int64 | Number of days left in trial |
| trial_until String | When does this Site trial expire? |
| user String | User of current session |
Resource Import
This Resource supports importing using the following syntax:
Data Source Schema
Read Only
| Property | Description |
|---|---|
| id Int64 | Site Id |
| name String | Site name |
| additional_text_file_types List | Additional extensions that are considered text files |
| ai_feature_availability Dynamic | Availability settings for AI features by user class |
| allowed_2fa_method_sms Bool | Is SMS two factor authentication allowed? |
| allowed_2fa_method_totp Bool | Is TOTP two factor authentication allowed? |
| allowed_2fa_method_webauthn Bool | Is WebAuthn two factor authentication allowed? |
| allowed_2fa_method_yubi Bool | Is yubikey two factor authentication allowed? |
| allowed_2fa_method_email Bool | Is OTP via email two factor authentication allowed? |
| allowed_2fa_method_static Bool | Is OTP via static codes for two factor authentication allowed? |
| allowed_2fa_method_bypass_for_ftp_sftp_dav Bool | Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV? |
| admin_user_id Int64 | User ID for the main site administrator |
| admins_bypass_locked_subfolders Bool | Allow admins to bypass the locked subfolders setting. |
| allow_bundle_names Bool | Are manual Bundle names allowed? |
| allow_user_level_2fa_override Bool | Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis? |
| allow_user_level_allowed_ip_override Bool | Allow the site-wide allowed IP restriction to be overriden on a per-user-basis? |
| allow_user_level_ssl_override Bool | Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis? |
| allowed_countries String | Comma separated list of allowed Country codes |
| allowed_ips String | List of allowed IP addresses |
| always_mkdir_parents Bool | 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. |
| as2_message_retention_days Int64 | Number of days to retain AS2 messages (incoming and outgoing). |
| ask_about_overwrites Bool | If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface. |
| bundle_activity_notifications String | Do Bundle owners receive activity notifications? Possible values: never, always, per_bundle_setting |
| bundle_expiration Int64 | Site-wide Bundle expiration in days |
| bundle_not_found_message String | Custom error message to show when bundle is not found. |
| bundle_password_required Bool | Do Bundles require password protection? |
| bundles_default_owned_by_primary_group Bool | If true, new Share Links created by a user with a primary group will default to that group as owner. |
| bundle_recipient_blacklist_domains List | List of email domains to disallow when entering a Bundle/Inbox recipients |
| bundle_recipient_blacklist_free_email_domains Bool | Disallow free email domains for Bundle/Inbox recipients? |
| bundle_registration_notifications String | Do Bundle owners receive registration notification? Possible values: never, always, per_bundle_setting |
| bundle_require_registration Bool | Do Bundles require registration? |
| bundle_require_share_recipient Bool | Do Bundles require recipients for sharing? |
| bundle_send_one_time_password_to_recipient_at_registration Bool | If true, new Share Links must send a one-time password to the recipient when they register. Requires bundle_require_share_recipient and cannot be enabled with bundle_password_required. |
| bundle_require_note Bool | Do Bundles require internal notes? |
| bundle_send_shared_receipts Bool | Do Bundle creators receive receipts of invitations? |
| bundle_upload_receipt_notifications String | Do Bundle uploaders receive upload confirmation notifications? Possible values: never, always, per_bundle_setting |
| bundle_watermark_attachment String | Preview watermark image applied to all bundle items. |
| bundle_watermark_value Dynamic | Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value |
| calculate_file_checksums_crc32 Bool | Calculate CRC32 checksums for files? |
| calculate_file_checksums_md5 Bool | Calculate MD5 checksums for files? |
| calculate_file_checksums_sha1 Bool | Calculate SHA1 checksums for files? |
| calculate_file_checksums_sha256 Bool | Calculate SHA256 checksums for files? |
| uploads_via_email_authentication Bool | Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC? |
| color2_left String | Page link and button color |
| color2_link String | Top bar link color |
| color2_text String | Page link and button color |
| color2_top String | Top bar background color |
| color2_top_text String | Top bar text color |
| contact_name String | Site main contact name |
| created_at String | Time this site was created |
| currency String | Preferred currency |
| custom_namespace Bool | Is this site using a custom namespace for users? |
| dav_enabled Bool | Is WebDAV enabled? |
| dav_user_root_enabled Bool | Use user FTP roots also for WebDAV? |
| days_to_retain_backups Int64 | Number of days to keep deleted files |
| document_edits_in_bundle_allowed Bool | If true, allow public viewers of Bundles with full permissions to use document editing integrations. |
| default_time_zone String | Site default time zone |
| desktop_app Bool | Is the desktop app enabled? |
| desktop_app_session_ip_pinning Bool | Is desktop app session IP pinning enabled? |
| desktop_app_session_lifetime Int64 | Desktop app session lifetime (in hours) |
| legacy_checksums_mode Bool | Use legacy checksums mode? |
| migrate_remote_server_sync_to_sync Bool | If true, we will migrate all remote server syncs to the new Sync model. |
| mcp_dcr_enabled Bool | Is OAuth DCR (dynamic client registration) for MCP enabled? |
| mobile_app Bool | Is the mobile app enabled? |
| mobile_app_session_ip_pinning Bool | Is mobile app session IP pinning enabled? |
| mobile_app_session_lifetime Int64 | Mobile app session lifetime (in hours) |
| disallowed_countries String | Comma separated list of disallowed Country codes |
| disable_all_ai_features Bool | If true, all AI features are disabled for this site. |
| disable_files_certificate_generation Bool | If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain. |
| disable_notifications Bool | Are notifications disabled? |
| disable_password_reset Bool | Is password reset disabled? |
| domain String | Custom domain |
| domain_hsts_header Bool | Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain? |
| domain_letsencrypt_chain String | Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026. Possible values: default, isrg_root_x1, dst_root_ca_x3 |
| email String | Main email for this site |
| fedramp Bool | Are FedRAMP security restrictions enabled for this site? |
| ftp_enabled Bool | Is FTP enabled? |
| reply_to_email String | Reply-to email for this site |
| non_sso_groups_allowed Bool | If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider. |
| non_sso_users_allowed Bool | If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider. |
| folder_permissions_groups_only Bool | If true, permissions for this site must be bound to a group (not a user). |
| group_admins_can_add_users Bool | Allow group admins to create users in their groups |
| group_admins_can_manage_group_memberships Bool | Allow group admins to add or remove existing users in their groups |
| group_admins_can_delete_users Bool | Allow group admins to delete users in their groups |
| group_admins_can_enable_disable_users Bool | Allow group admins to enable or disable users in their groups |
| group_admins_can_modify_users Bool | Allow group admins to modify users in their groups |
| group_admins_can_bypass_user_lifecycle_rules Bool | Allow group admins to exempt users in their groups from lifecycle rules |
| group_admins_can_reset_passwords Bool | Allow group admins to reset passwords for users in their groups |
| group_admins_can_set_user_password Bool | Allow group admins to set password authentication method |
| hipaa Bool | Is there a signed HIPAA BAA between Files.com and this site? |
| icon128 String | Branded icon 128x128 |
| icon16 String | Branded icon 16x16 |
| icon32 String | Branded icon 32x32 |
| icon48 String | Branded icon 48x48 |
| immutable_files_set_at String | Can files be modified? |
| include_password_in_welcome_email Bool | Include password in emails to new users? |
| language String | Site default language |
| ldap_base_dn String | Base DN for looking up users in LDAP server |
| ldap_domain String | Domain name that will be appended to usernames |
| ldap_enabled Bool | Main LDAP setting: is LDAP enabled? |
| ldap_group_action String | Should we sync groups from LDAP server? |
| ldap_group_exclusion String | Comma or newline separated list of group names (with optional wildcards) to exclude when syncing. |
| ldap_group_inclusion String | Comma or newline separated list of group names (with optional wildcards) to include when syncing. |
| ldap_host String | LDAP host |
| ldap_host_2 String | LDAP backup host |
| ldap_host_3 String | LDAP backup host |
| ldap_port Int64 | LDAP port |
| ldap_secure Bool | Use secure LDAP? |
| ldap_type String | LDAP type |
| ldap_user_action String | Should we sync users from LDAP server? |
| 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. |
| ldap_username String | Username for signing in to LDAP server. |
| ldap_username_field String | LDAP username field |
| login_help_text String | Login help text |
| logo String | Branded logo |
| login_page_background_image String | Branded login page background |
| max_prior_passwords Int64 | Number of prior passwords to disallow |
| managed_site_settings Dynamic | List of site settings managed by the parent site |
| motd_text String | A message to show users when they connect via FTP or SFTP. |
| motd_use_for_ftp Bool | Show message to users connecting via FTP |
| motd_use_for_sftp Bool | Show message to users connecting via SFTP |
| next_billing_amount String | Next billing amount |
| next_billing_date String | Next billing date |
| office_integration_available Bool | If true, allows users to use a document editing integration. |
| office_integration_type String | Which document editing integration to support. Files.com Editor or Microsoft Office for the Web. Possible values: only_office, office_365, disabled |
| oncehub_link String | Link to scheduling a meeting with our Sales team |
| opt_out_global Bool | Use servers in the USA only? |
| overdue Bool | Is this site's billing overdue? |
| password_min_length Int64 | Shortest password length for users |
| password_require_letter Bool | Require a letter in passwords? |
| password_require_mixed Bool | Require lower and upper case letters in passwords? |
| password_require_number Bool | Require a number in passwords? |
| password_require_special Bool | Require special characters in password? |
| password_require_unbreached Bool | Require passwords that have not been previously breached? (see https://haveibeenpwned.com/) |
| password_requirements_apply_to_bundles Bool | Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords? |
| password_validity_days Int64 | Number of days password is valid |
| phone String | Site phone number |
| pin_all_remote_servers_to_site_region Bool | 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. |
| prevent_root_permissions_for_non_site_admins Bool | 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. |
| protocol_access_groups_only Bool | 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. |
| require_2fa Bool | Require two-factor authentication for all users? |
| restrict_root_folder_behaviors_to_site_admins Bool | If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one. |
| root_folder_behaviors_apply_to_workspaces Bool | If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrict_root_folder_behaviors_to_site_admins to be enabled. |
| require_2fa_exempt_all_sso_users Bool | If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement. |
| require_2fa_stop_time String | If set, requirement for two-factor authentication has been scheduled to end on this date-time. |
| revoke_bundle_access_on_disable_or_delete Bool | Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period. |
| 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)?Possible values: all, folder_and_site_admins, site_admins |
| require_logout_from_bundles_and_inboxes Bool | 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. |
| session String | Current session |
| sftp_enabled Bool | Is SFTP enabled? |
| sftp_finalize_partial_uploads Bool | Finalize partial SFTP uploads from interrupted connections? Default: true. |
| sftp_host_key_type String | Sftp Host Key Type Possible values: default, exavault, custom, smartfile |
| active_sftp_host_key_id Int64 | Id of the currently selected custom SFTP Host Key |
| active_sftp_host_key_ids List | Ids of the selected custom SFTP Host Keys |
| sftp_insecure_ciphers Bool | 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. |
| sftp_insecure_diffie_hellman Bool | 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. |
| sftp_user_root_enabled Bool | Use user FTP roots also for SFTP? |
| sharing_enabled Bool | Allow bundle creation |
| show_user_notifications_log_in_link Bool | Show log in link in user notifications? |
| show_request_access_link Bool | Show request access link for users without access? Currently unused. |
| site_footer String | Custom site footer text for authenticated pages |
| site_header String | Custom site header text for authenticated pages |
| site_public_footer String | Custom site footer text for public pages |
| site_public_header String | Custom site header text for public pages |
| smtp_address String | SMTP server hostname or IP |
| smtp_authentication String | SMTP server authentication type |
| smtp_from String | From address to use when mailing through custom SMTP |
| smtp_port Int64 | SMTP server port |
| smtp_username String | SMTP server username |
| session_expiry_minutes Int64 | Session expiry in minutes |
| snapshot_sharing_enabled Bool | Allow snapshot share links creation |
| ssl_required Bool | Is SSL required? Disabling this is insecure. |
| subdomain String | Site subdomain |
| switch_to_plan_date String | If switching plans, when does the new plan take effect? |
| trial_days_left Int64 | Number of days left in trial |
| trial_until String | When does this Site trial expire? |
| use_dedicated_ips_for_smtp Bool | If using custom SMTP, should we use dedicated IPs to deliver emails? |
| use_provided_modified_at Bool | Allow uploaders to set provided_modified_at for uploaded files? |
| user String | User of current session |
| user_lockout Bool | Will users be locked out after incorrect login attempts? |
| user_lockout_lock_period Int64 | How many hours to lock user out for failed password? |
| user_lockout_tries Int64 | Number of login tries within user_lockout_within hours before users are locked out |
| user_lockout_within Int64 | Number of hours for user lockout window |
| user_requests_enabled Bool | Enable User Requests feature |
| user_requests_notify_admins Bool | Send email to site admins when a user request is received? |
| users_can_create_api_keys Bool | Allow users to create their own API keys? |
| users_can_create_ssh_keys Bool | Allow users to create their own SSH keys? |
| 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.Possible values: username_only, full_name_only, full_name_username, full_name_company, full_name_username_company |
| welcome_custom_text String | Custom text send in user welcome email |
| 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). |
| welcome_email_cc String | Include this email in welcome emails if enabled |
| welcome_email_subject String | Include this email subject in welcome emails if enabled |
| welcome_email_enabled Bool | Will the welcome email be sent to new users? |
| welcome_screen String | Does the welcome screen appear? Possible values: enabled, hidden, disabled |
| windows_mode_ftp Bool | Does FTP user Windows emulation mode? |