Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
published on Thursday, Aug 20, 2026 by jschady
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
published on Thursday, Aug 20, 2026 by jschady
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.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";
const exampleSite = new filescom.Site("example_site", {
name: "My Site",
subdomain: "mysite",
domain: "my-custom-domain.com",
domainHstsHeader: false,
domainLetsencryptChain: "example",
email: "john.doe@files.com",
replyToEmail: "jane.doe@files.com",
allowBundleNames: false,
bundleExpiration: 1,
welcomeEmailEnabled: false,
askAboutOverwrites: false,
showRequestAccessLink: false,
alwaysMkdirParents: false,
welcomeEmailCc: "example",
welcomeEmailSubject: "example",
welcomeCustomText: "Welcome to my site!",
language: "en",
windowsModeFtp: false,
defaultTimeZone: "Pacific Time (US & Canada)",
desktopApp: false,
desktopAppSessionIpPinning: false,
desktopAppSessionLifetime: 1,
mobileApp: false,
mobileAppSessionIpPinning: false,
mobileAppSessionLifetime: 1,
folderPermissionsGroupsOnly: false,
welcomeScreen: "user_controlled",
officeIntegrationAvailable: false,
officeIntegrationType: "example",
pinAllRemoteServersToSiteRegion: false,
motdText: "example",
motdUseForFtp: false,
motdUseForSftp: false,
disableAllAiFeatures: false,
aiFeatureAvailability: {
inAppAiAssistant: {
siteAdmins: true,
workspaceAdmins: true,
folderAdmins: true,
allUsers: true,
},
},
mcpDcrEnabled: false,
additionalTextFileTypes: ["example"],
bundleRequireNote: false,
bundleSendSharedReceipts: false,
bundlesDefaultOwnedByPrimaryGroup: false,
calculateFileChecksumsCrc32: false,
calculateFileChecksumsMd5: false,
calculateFileChecksumsSha1: false,
calculateFileChecksumsSha256: false,
legacyChecksumsMode: false,
migrateRemoteServerSyncToSync: false,
as2MessageRetentionDays: 1,
usernameDisplay: "username_only",
sessionExpiryMinutes: 1,
sslRequired: false,
sftpInsecureCiphers: false,
sftpInsecureDiffieHellman: false,
disableFilesCertificateGeneration: false,
fedramp: false,
userLockout: false,
userLockoutTries: 1,
userLockoutWithin: 1,
userLockoutLockPeriod: 1,
includePasswordInWelcomeEmail: false,
allowedCountries: "US,DE",
allowedIps: "example",
allowUserLevel2faOverride: false,
allowUserLevelAllowedIpOverride: false,
allowUserLevelSslOverride: false,
disallowedCountries: "US,DE",
daysToRetainBackups: 1,
maxPriorPasswords: 1,
passwordValidityDays: 1,
passwordMinLength: 1,
passwordRequireLetter: false,
passwordRequireMixed: false,
passwordRequireSpecial: false,
passwordRequireNumber: false,
passwordRequireUnbreached: false,
requireLogoutFromBundlesAndInboxes: false,
davUserRootEnabled: false,
sftpUserRootEnabled: false,
disablePasswordReset: false,
immutableFiles: false,
bundleNotFoundMessage: "example",
bundlePasswordRequired: false,
bundleRequireRegistration: false,
bundleRequireShareRecipient: false,
bundleSendOneTimePasswordToRecipientAtRegistration: false,
bundleRegistrationNotifications: "never",
bundleActivityNotifications: "never",
bundleUploadReceiptNotifications: "never",
documentEditsInBundleAllowed: false,
passwordRequirementsApplyToBundles: false,
preventRootPermissionsForNonSiteAdmins: false,
restrictRootFolderBehaviorsToSiteAdmins: false,
rootFolderBehaviorsApplyToWorkspaces: false,
optOutGlobal: false,
useProvidedModifiedAt: false,
customNamespace: false,
nonSsoGroupsAllowed: false,
nonSsoUsersAllowed: false,
sharingEnabled: false,
snapshotSharingEnabled: false,
userRequestsEnabled: false,
userRequestsNotifyAdmins: false,
davEnabled: false,
ftpEnabled: false,
sftpEnabled: false,
sftpFinalizePartialUploads: false,
usersCanCreateApiKeys: false,
usersCanCreateSshKeys: false,
showUserNotificationsLogInLink: false,
sftpHostKeyType: "default",
activeSftpHostKeyId: 1,
protocolAccessGroupsOnly: false,
revokeBundleAccessOnDisableOrDelete: false,
bundleWatermarkValue: {
key: "example value",
},
groupAdminsCanAddUsers: false,
groupAdminsCanManageGroupMemberships: false,
groupAdminsCanDeleteUsers: false,
groupAdminsCanEnableDisableUsers: false,
groupAdminsCanModifyUsers: false,
groupAdminsCanBypassUserLifecycleRules: false,
groupAdminsCanResetPasswords: false,
groupAdminsCanSetUserPassword: false,
bundleRecipientBlacklistFreeEmailDomains: false,
bundleRecipientBlacklistDomains: ["example"],
adminsBypassLockedSubfolders: false,
allowed2faMethodSms: false,
allowed2faMethodTotp: false,
allowed2faMethodWebauthn: false,
allowed2faMethodYubi: false,
allowed2faMethodEmail: false,
allowed2faMethodStatic: false,
allowed2faMethodBypassForFtpSftpDav: false,
require2fa: false,
require2faExemptAllSsoUsers: false,
require2faUserType: "`site_admins`",
color2Top: "#000000",
color2Left: "#0066a7",
color2Link: "#d34f5d",
color2Text: "#0066a7",
color2TopText: "#ffffff",
siteHeader: "example",
siteFooter: "example",
sitePublicHeader: "example",
sitePublicFooter: "example",
loginHelpText: "Login page help text.",
useDedicatedIpsForSmtp: false,
emailFooterCustomText: "Copyright © %Y MyCompany Inc.",
smtpAddress: "smtp.my-mail-server.com",
smtpAuthentication: "plain",
smtpFrom: "me@my-mail-server.com",
smtpUsername: "mail",
smtpPort: 1,
ldapEnabled: false,
ldapType: "open_ldap",
ldapHost: "ldap.site.com",
ldapHost2: "ldap2.site.com",
ldapHost3: "ldap3.site.com",
ldapPort: 1,
ldapSecure: false,
ldapUsername: "[ldap username]",
ldapUsernameField: "sAMAccountName",
ldapDomain: "mysite.com",
ldapUserAction: "disabled",
ldapGroupAction: "disabled",
ldapUserIncludeGroups: "example",
ldapGroupExclusion: "example",
ldapGroupInclusion: "example",
ldapBaseDn: "example",
uploadsViaEmailAuthentication: false,
icon16Delete: false,
icon32Delete: false,
icon48Delete: false,
icon128Delete: false,
logoDelete: false,
bundleWatermarkAttachmentDelete: false,
loginPageBackgroundImageDelete: false,
disable2faWithDelay: false,
redirectOldSubdomain: false,
});
import pulumi
import pulumi_filescom as filescom
example_site = filescom.Site("example_site",
name="My Site",
subdomain="mysite",
domain="my-custom-domain.com",
domain_hsts_header=False,
domain_letsencrypt_chain="example",
email="john.doe@files.com",
reply_to_email="jane.doe@files.com",
allow_bundle_names=False,
bundle_expiration=1,
welcome_email_enabled=False,
ask_about_overwrites=False,
show_request_access_link=False,
always_mkdir_parents=False,
welcome_email_cc="example",
welcome_email_subject="example",
welcome_custom_text="Welcome to my site!",
language="en",
windows_mode_ftp=False,
default_time_zone="Pacific Time (US & Canada)",
desktop_app=False,
desktop_app_session_ip_pinning=False,
desktop_app_session_lifetime=1,
mobile_app=False,
mobile_app_session_ip_pinning=False,
mobile_app_session_lifetime=1,
folder_permissions_groups_only=False,
welcome_screen="user_controlled",
office_integration_available=False,
office_integration_type="example",
pin_all_remote_servers_to_site_region=False,
motd_text="example",
motd_use_for_ftp=False,
motd_use_for_sftp=False,
disable_all_ai_features=False,
ai_feature_availability={
"inAppAiAssistant": {
"siteAdmins": True,
"workspaceAdmins": True,
"folderAdmins": True,
"allUsers": True,
},
},
mcp_dcr_enabled=False,
additional_text_file_types=["example"],
bundle_require_note=False,
bundle_send_shared_receipts=False,
bundles_default_owned_by_primary_group=False,
calculate_file_checksums_crc32=False,
calculate_file_checksums_md5=False,
calculate_file_checksums_sha1=False,
calculate_file_checksums_sha256=False,
legacy_checksums_mode=False,
migrate_remote_server_sync_to_sync=False,
as2_message_retention_days=1,
username_display="username_only",
session_expiry_minutes=1,
ssl_required=False,
sftp_insecure_ciphers=False,
sftp_insecure_diffie_hellman=False,
disable_files_certificate_generation=False,
fedramp=False,
user_lockout=False,
user_lockout_tries=1,
user_lockout_within=1,
user_lockout_lock_period=1,
include_password_in_welcome_email=False,
allowed_countries="US,DE",
allowed_ips="example",
allow_user_level2fa_override=False,
allow_user_level_allowed_ip_override=False,
allow_user_level_ssl_override=False,
disallowed_countries="US,DE",
days_to_retain_backups=1,
max_prior_passwords=1,
password_validity_days=1,
password_min_length=1,
password_require_letter=False,
password_require_mixed=False,
password_require_special=False,
password_require_number=False,
password_require_unbreached=False,
require_logout_from_bundles_and_inboxes=False,
dav_user_root_enabled=False,
sftp_user_root_enabled=False,
disable_password_reset=False,
immutable_files=False,
bundle_not_found_message="example",
bundle_password_required=False,
bundle_require_registration=False,
bundle_require_share_recipient=False,
bundle_send_one_time_password_to_recipient_at_registration=False,
bundle_registration_notifications="never",
bundle_activity_notifications="never",
bundle_upload_receipt_notifications="never",
document_edits_in_bundle_allowed=False,
password_requirements_apply_to_bundles=False,
prevent_root_permissions_for_non_site_admins=False,
restrict_root_folder_behaviors_to_site_admins=False,
root_folder_behaviors_apply_to_workspaces=False,
opt_out_global=False,
use_provided_modified_at=False,
custom_namespace=False,
non_sso_groups_allowed=False,
non_sso_users_allowed=False,
sharing_enabled=False,
snapshot_sharing_enabled=False,
user_requests_enabled=False,
user_requests_notify_admins=False,
dav_enabled=False,
ftp_enabled=False,
sftp_enabled=False,
sftp_finalize_partial_uploads=False,
users_can_create_api_keys=False,
users_can_create_ssh_keys=False,
show_user_notifications_log_in_link=False,
sftp_host_key_type="default",
active_sftp_host_key_id=1,
protocol_access_groups_only=False,
revoke_bundle_access_on_disable_or_delete=False,
bundle_watermark_value={
"key": "example value",
},
group_admins_can_add_users=False,
group_admins_can_manage_group_memberships=False,
group_admins_can_delete_users=False,
group_admins_can_enable_disable_users=False,
group_admins_can_modify_users=False,
group_admins_can_bypass_user_lifecycle_rules=False,
group_admins_can_reset_passwords=False,
group_admins_can_set_user_password=False,
bundle_recipient_blacklist_free_email_domains=False,
bundle_recipient_blacklist_domains=["example"],
admins_bypass_locked_subfolders=False,
allowed2fa_method_sms=False,
allowed2fa_method_totp=False,
allowed2fa_method_webauthn=False,
allowed2fa_method_yubi=False,
allowed2fa_method_email=False,
allowed2fa_method_static=False,
allowed2fa_method_bypass_for_ftp_sftp_dav=False,
require2fa=False,
require2fa_exempt_all_sso_users=False,
require2fa_user_type="`site_admins`",
color2_top="#000000",
color2_left="#0066a7",
color2_link="#d34f5d",
color2_text="#0066a7",
color2_top_text="#ffffff",
site_header="example",
site_footer="example",
site_public_header="example",
site_public_footer="example",
login_help_text="Login page help text.",
use_dedicated_ips_for_smtp=False,
email_footer_custom_text="Copyright © %Y MyCompany Inc.",
smtp_address="smtp.my-mail-server.com",
smtp_authentication="plain",
smtp_from="me@my-mail-server.com",
smtp_username="mail",
smtp_port=1,
ldap_enabled=False,
ldap_type="open_ldap",
ldap_host="ldap.site.com",
ldap_host2="ldap2.site.com",
ldap_host3="ldap3.site.com",
ldap_port=1,
ldap_secure=False,
ldap_username="[ldap username]",
ldap_username_field="sAMAccountName",
ldap_domain="mysite.com",
ldap_user_action="disabled",
ldap_group_action="disabled",
ldap_user_include_groups="example",
ldap_group_exclusion="example",
ldap_group_inclusion="example",
ldap_base_dn="example",
uploads_via_email_authentication=False,
icon16_delete=False,
icon32_delete=False,
icon48_delete=False,
icon128_delete=False,
logo_delete=False,
bundle_watermark_attachment_delete=False,
login_page_background_image_delete=False,
disable2fa_with_delay=False,
redirect_old_subdomain=False)
package main
import (
"github.com/jschady/pulumi-filescom/sdk/go/filescom"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := filescom.NewSite(ctx, "example_site", &filescom.SiteArgs{
Name: pulumi.String("My Site"),
Subdomain: pulumi.String("mysite"),
Domain: pulumi.String("my-custom-domain.com"),
DomainHstsHeader: pulumi.Bool(false),
DomainLetsencryptChain: pulumi.String("example"),
Email: pulumi.String("john.doe@files.com"),
ReplyToEmail: pulumi.String("jane.doe@files.com"),
AllowBundleNames: pulumi.Bool(false),
BundleExpiration: pulumi.Int(1),
WelcomeEmailEnabled: pulumi.Bool(false),
AskAboutOverwrites: pulumi.Bool(false),
ShowRequestAccessLink: pulumi.Bool(false),
AlwaysMkdirParents: pulumi.Bool(false),
WelcomeEmailCc: pulumi.String("example"),
WelcomeEmailSubject: pulumi.String("example"),
WelcomeCustomText: pulumi.String("Welcome to my site!"),
Language: pulumi.String("en"),
WindowsModeFtp: pulumi.Bool(false),
DefaultTimeZone: pulumi.String("Pacific Time (US & Canada)"),
DesktopApp: pulumi.Bool(false),
DesktopAppSessionIpPinning: pulumi.Bool(false),
DesktopAppSessionLifetime: pulumi.Int(1),
MobileApp: pulumi.Bool(false),
MobileAppSessionIpPinning: pulumi.Bool(false),
MobileAppSessionLifetime: pulumi.Int(1),
FolderPermissionsGroupsOnly: pulumi.Bool(false),
WelcomeScreen: pulumi.String("user_controlled"),
OfficeIntegrationAvailable: pulumi.Bool(false),
OfficeIntegrationType: pulumi.String("example"),
PinAllRemoteServersToSiteRegion: pulumi.Bool(false),
MotdText: pulumi.String("example"),
MotdUseForFtp: pulumi.Bool(false),
MotdUseForSftp: pulumi.Bool(false),
DisableAllAiFeatures: pulumi.Bool(false),
AiFeatureAvailability: pulumi.Any(map[string]interface{}{
"inAppAiAssistant": map[string]bool{
"siteAdmins": true,
"workspaceAdmins": true,
"folderAdmins": true,
"allUsers": true,
},
}),
McpDcrEnabled: pulumi.Bool(false),
AdditionalTextFileTypes: pulumi.StringArray{
pulumi.String("example"),
},
BundleRequireNote: pulumi.Bool(false),
BundleSendSharedReceipts: pulumi.Bool(false),
BundlesDefaultOwnedByPrimaryGroup: pulumi.Bool(false),
CalculateFileChecksumsCrc32: pulumi.Bool(false),
CalculateFileChecksumsMd5: pulumi.Bool(false),
CalculateFileChecksumsSha1: pulumi.Bool(false),
CalculateFileChecksumsSha256: pulumi.Bool(false),
LegacyChecksumsMode: pulumi.Bool(false),
MigrateRemoteServerSyncToSync: pulumi.Bool(false),
As2MessageRetentionDays: pulumi.Int(1),
UsernameDisplay: pulumi.String("username_only"),
SessionExpiryMinutes: pulumi.Int(1),
SslRequired: pulumi.Bool(false),
SftpInsecureCiphers: pulumi.Bool(false),
SftpInsecureDiffieHellman: pulumi.Bool(false),
DisableFilesCertificateGeneration: pulumi.Bool(false),
Fedramp: pulumi.Bool(false),
UserLockout: pulumi.Bool(false),
UserLockoutTries: pulumi.Int(1),
UserLockoutWithin: pulumi.Int(1),
UserLockoutLockPeriod: pulumi.Int(1),
IncludePasswordInWelcomeEmail: pulumi.Bool(false),
AllowedCountries: pulumi.String("US,DE"),
AllowedIps: pulumi.String("example"),
AllowUserLevel2faOverride: pulumi.Bool(false),
AllowUserLevelAllowedIpOverride: pulumi.Bool(false),
AllowUserLevelSslOverride: pulumi.Bool(false),
DisallowedCountries: pulumi.String("US,DE"),
DaysToRetainBackups: pulumi.Int(1),
MaxPriorPasswords: pulumi.Int(1),
PasswordValidityDays: pulumi.Int(1),
PasswordMinLength: pulumi.Int(1),
PasswordRequireLetter: pulumi.Bool(false),
PasswordRequireMixed: pulumi.Bool(false),
PasswordRequireSpecial: pulumi.Bool(false),
PasswordRequireNumber: pulumi.Bool(false),
PasswordRequireUnbreached: pulumi.Bool(false),
RequireLogoutFromBundlesAndInboxes: pulumi.Bool(false),
DavUserRootEnabled: pulumi.Bool(false),
SftpUserRootEnabled: pulumi.Bool(false),
DisablePasswordReset: pulumi.Bool(false),
ImmutableFiles: false,
BundleNotFoundMessage: pulumi.String("example"),
BundlePasswordRequired: pulumi.Bool(false),
BundleRequireRegistration: pulumi.Bool(false),
BundleRequireShareRecipient: pulumi.Bool(false),
BundleSendOneTimePasswordToRecipientAtRegistration: pulumi.Bool(false),
BundleRegistrationNotifications: pulumi.String("never"),
BundleActivityNotifications: pulumi.String("never"),
BundleUploadReceiptNotifications: pulumi.String("never"),
DocumentEditsInBundleAllowed: pulumi.Bool(false),
PasswordRequirementsApplyToBundles: pulumi.Bool(false),
PreventRootPermissionsForNonSiteAdmins: pulumi.Bool(false),
RestrictRootFolderBehaviorsToSiteAdmins: pulumi.Bool(false),
RootFolderBehaviorsApplyToWorkspaces: pulumi.Bool(false),
OptOutGlobal: pulumi.Bool(false),
UseProvidedModifiedAt: pulumi.Bool(false),
CustomNamespace: pulumi.Bool(false),
NonSsoGroupsAllowed: pulumi.Bool(false),
NonSsoUsersAllowed: pulumi.Bool(false),
SharingEnabled: pulumi.Bool(false),
SnapshotSharingEnabled: pulumi.Bool(false),
UserRequestsEnabled: pulumi.Bool(false),
UserRequestsNotifyAdmins: pulumi.Bool(false),
DavEnabled: pulumi.Bool(false),
FtpEnabled: pulumi.Bool(false),
SftpEnabled: pulumi.Bool(false),
SftpFinalizePartialUploads: pulumi.Bool(false),
UsersCanCreateApiKeys: pulumi.Bool(false),
UsersCanCreateSshKeys: pulumi.Bool(false),
ShowUserNotificationsLogInLink: pulumi.Bool(false),
SftpHostKeyType: pulumi.String("default"),
ActiveSftpHostKeyId: pulumi.Int(1),
ProtocolAccessGroupsOnly: pulumi.Bool(false),
RevokeBundleAccessOnDisableOrDelete: pulumi.Bool(false),
BundleWatermarkValue: pulumi.Any(map[string]interface{}{
"key": "example value",
}),
GroupAdminsCanAddUsers: pulumi.Bool(false),
GroupAdminsCanManageGroupMemberships: pulumi.Bool(false),
GroupAdminsCanDeleteUsers: pulumi.Bool(false),
GroupAdminsCanEnableDisableUsers: pulumi.Bool(false),
GroupAdminsCanModifyUsers: pulumi.Bool(false),
GroupAdminsCanBypassUserLifecycleRules: pulumi.Bool(false),
GroupAdminsCanResetPasswords: pulumi.Bool(false),
GroupAdminsCanSetUserPassword: pulumi.Bool(false),
BundleRecipientBlacklistFreeEmailDomains: pulumi.Bool(false),
BundleRecipientBlacklistDomains: pulumi.StringArray{
pulumi.String("example"),
},
AdminsBypassLockedSubfolders: pulumi.Bool(false),
Allowed2faMethodSms: pulumi.Bool(false),
Allowed2faMethodTotp: pulumi.Bool(false),
Allowed2faMethodWebauthn: pulumi.Bool(false),
Allowed2faMethodYubi: pulumi.Bool(false),
Allowed2faMethodEmail: pulumi.Bool(false),
Allowed2faMethodStatic: pulumi.Bool(false),
Allowed2faMethodBypassForFtpSftpDav: pulumi.Bool(false),
Require2fa: pulumi.Bool(false),
Require2faExemptAllSsoUsers: pulumi.Bool(false),
Require2faUserType: pulumi.String("`site_admins`"),
Color2Top: pulumi.String("#000000"),
Color2Left: pulumi.String("#0066a7"),
Color2Link: pulumi.String("#d34f5d"),
Color2Text: pulumi.String("#0066a7"),
Color2TopText: pulumi.String("#ffffff"),
SiteHeader: pulumi.String("example"),
SiteFooter: pulumi.String("example"),
SitePublicHeader: pulumi.String("example"),
SitePublicFooter: pulumi.String("example"),
LoginHelpText: pulumi.String("Login page help text."),
UseDedicatedIpsForSmtp: pulumi.Bool(false),
EmailFooterCustomText: pulumi.String("Copyright © %Y MyCompany Inc."),
SmtpAddress: pulumi.String("smtp.my-mail-server.com"),
SmtpAuthentication: pulumi.String("plain"),
SmtpFrom: pulumi.String("me@my-mail-server.com"),
SmtpUsername: pulumi.String("mail"),
SmtpPort: pulumi.Int(1),
LdapEnabled: pulumi.Bool(false),
LdapType: pulumi.String("open_ldap"),
LdapHost: pulumi.String("ldap.site.com"),
LdapHost2: pulumi.String("ldap2.site.com"),
LdapHost3: pulumi.String("ldap3.site.com"),
LdapPort: pulumi.Int(1),
LdapSecure: pulumi.Bool(false),
LdapUsername: pulumi.String("[ldap username]"),
LdapUsernameField: pulumi.String("sAMAccountName"),
LdapDomain: pulumi.String("mysite.com"),
LdapUserAction: pulumi.String("disabled"),
LdapGroupAction: pulumi.String("disabled"),
LdapUserIncludeGroups: pulumi.String("example"),
LdapGroupExclusion: pulumi.String("example"),
LdapGroupInclusion: pulumi.String("example"),
LdapBaseDn: pulumi.String("example"),
UploadsViaEmailAuthentication: pulumi.Bool(false),
Icon16Delete: false,
Icon32Delete: false,
Icon48Delete: false,
Icon128Delete: false,
LogoDelete: false,
BundleWatermarkAttachmentDelete: false,
LoginPageBackgroundImageDelete: false,
Disable2faWithDelay: false,
RedirectOldSubdomain: false,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;
return await Deployment.RunAsync(() =>
{
var exampleSite = new Filescom.Site("example_site", new()
{
Name = "My Site",
Subdomain = "mysite",
Domain = "my-custom-domain.com",
DomainHstsHeader = false,
DomainLetsencryptChain = "example",
Email = "john.doe@files.com",
ReplyToEmail = "jane.doe@files.com",
AllowBundleNames = false,
BundleExpiration = 1,
WelcomeEmailEnabled = false,
AskAboutOverwrites = false,
ShowRequestAccessLink = false,
AlwaysMkdirParents = false,
WelcomeEmailCc = "example",
WelcomeEmailSubject = "example",
WelcomeCustomText = "Welcome to my site!",
Language = "en",
WindowsModeFtp = false,
DefaultTimeZone = "Pacific Time (US & Canada)",
DesktopApp = false,
DesktopAppSessionIpPinning = false,
DesktopAppSessionLifetime = 1,
MobileApp = false,
MobileAppSessionIpPinning = false,
MobileAppSessionLifetime = 1,
FolderPermissionsGroupsOnly = false,
WelcomeScreen = "user_controlled",
OfficeIntegrationAvailable = false,
OfficeIntegrationType = "example",
PinAllRemoteServersToSiteRegion = false,
MotdText = "example",
MotdUseForFtp = false,
MotdUseForSftp = false,
DisableAllAiFeatures = false,
AiFeatureAvailability = new Dictionary<string, object?>
{
["inAppAiAssistant"] = new Dictionary<string, object?>
{
["siteAdmins"] = true,
["workspaceAdmins"] = true,
["folderAdmins"] = true,
["allUsers"] = true,
},
},
McpDcrEnabled = false,
AdditionalTextFileTypes = new[]
{
"example",
},
BundleRequireNote = false,
BundleSendSharedReceipts = false,
BundlesDefaultOwnedByPrimaryGroup = false,
CalculateFileChecksumsCrc32 = false,
CalculateFileChecksumsMd5 = false,
CalculateFileChecksumsSha1 = false,
CalculateFileChecksumsSha256 = false,
LegacyChecksumsMode = false,
MigrateRemoteServerSyncToSync = false,
As2MessageRetentionDays = 1,
UsernameDisplay = "username_only",
SessionExpiryMinutes = 1,
SslRequired = false,
SftpInsecureCiphers = false,
SftpInsecureDiffieHellman = false,
DisableFilesCertificateGeneration = false,
Fedramp = false,
UserLockout = false,
UserLockoutTries = 1,
UserLockoutWithin = 1,
UserLockoutLockPeriod = 1,
IncludePasswordInWelcomeEmail = false,
AllowedCountries = "US,DE",
AllowedIps = "example",
AllowUserLevel2faOverride = false,
AllowUserLevelAllowedIpOverride = false,
AllowUserLevelSslOverride = false,
DisallowedCountries = "US,DE",
DaysToRetainBackups = 1,
MaxPriorPasswords = 1,
PasswordValidityDays = 1,
PasswordMinLength = 1,
PasswordRequireLetter = false,
PasswordRequireMixed = false,
PasswordRequireSpecial = false,
PasswordRequireNumber = false,
PasswordRequireUnbreached = false,
RequireLogoutFromBundlesAndInboxes = false,
DavUserRootEnabled = false,
SftpUserRootEnabled = false,
DisablePasswordReset = false,
ImmutableFiles = false,
BundleNotFoundMessage = "example",
BundlePasswordRequired = false,
BundleRequireRegistration = false,
BundleRequireShareRecipient = false,
BundleSendOneTimePasswordToRecipientAtRegistration = false,
BundleRegistrationNotifications = "never",
BundleActivityNotifications = "never",
BundleUploadReceiptNotifications = "never",
DocumentEditsInBundleAllowed = false,
PasswordRequirementsApplyToBundles = false,
PreventRootPermissionsForNonSiteAdmins = false,
RestrictRootFolderBehaviorsToSiteAdmins = false,
RootFolderBehaviorsApplyToWorkspaces = false,
OptOutGlobal = false,
UseProvidedModifiedAt = false,
CustomNamespace = false,
NonSsoGroupsAllowed = false,
NonSsoUsersAllowed = false,
SharingEnabled = false,
SnapshotSharingEnabled = false,
UserRequestsEnabled = false,
UserRequestsNotifyAdmins = false,
DavEnabled = false,
FtpEnabled = false,
SftpEnabled = false,
SftpFinalizePartialUploads = false,
UsersCanCreateApiKeys = false,
UsersCanCreateSshKeys = false,
ShowUserNotificationsLogInLink = false,
SftpHostKeyType = "default",
ActiveSftpHostKeyId = 1,
ProtocolAccessGroupsOnly = false,
RevokeBundleAccessOnDisableOrDelete = false,
BundleWatermarkValue = new Dictionary<string, object?>
{
["key"] = "example value",
},
GroupAdminsCanAddUsers = false,
GroupAdminsCanManageGroupMemberships = false,
GroupAdminsCanDeleteUsers = false,
GroupAdminsCanEnableDisableUsers = false,
GroupAdminsCanModifyUsers = false,
GroupAdminsCanBypassUserLifecycleRules = false,
GroupAdminsCanResetPasswords = false,
GroupAdminsCanSetUserPassword = false,
BundleRecipientBlacklistFreeEmailDomains = false,
BundleRecipientBlacklistDomains = new[]
{
"example",
},
AdminsBypassLockedSubfolders = false,
Allowed2faMethodSms = false,
Allowed2faMethodTotp = false,
Allowed2faMethodWebauthn = false,
Allowed2faMethodYubi = false,
Allowed2faMethodEmail = false,
Allowed2faMethodStatic = false,
Allowed2faMethodBypassForFtpSftpDav = false,
Require2fa = false,
Require2faExemptAllSsoUsers = false,
Require2faUserType = "`site_admins`",
Color2Top = "#000000",
Color2Left = "#0066a7",
Color2Link = "#d34f5d",
Color2Text = "#0066a7",
Color2TopText = "#ffffff",
SiteHeader = "example",
SiteFooter = "example",
SitePublicHeader = "example",
SitePublicFooter = "example",
LoginHelpText = "Login page help text.",
UseDedicatedIpsForSmtp = false,
EmailFooterCustomText = "Copyright © %Y MyCompany Inc.",
SmtpAddress = "smtp.my-mail-server.com",
SmtpAuthentication = "plain",
SmtpFrom = "me@my-mail-server.com",
SmtpUsername = "mail",
SmtpPort = 1,
LdapEnabled = false,
LdapType = "open_ldap",
LdapHost = "ldap.site.com",
LdapHost2 = "ldap2.site.com",
LdapHost3 = "ldap3.site.com",
LdapPort = 1,
LdapSecure = false,
LdapUsername = "[ldap username]",
LdapUsernameField = "sAMAccountName",
LdapDomain = "mysite.com",
LdapUserAction = "disabled",
LdapGroupAction = "disabled",
LdapUserIncludeGroups = "example",
LdapGroupExclusion = "example",
LdapGroupInclusion = "example",
LdapBaseDn = "example",
UploadsViaEmailAuthentication = false,
Icon16Delete = false,
Icon32Delete = false,
Icon48Delete = false,
Icon128Delete = false,
LogoDelete = false,
BundleWatermarkAttachmentDelete = false,
LoginPageBackgroundImageDelete = false,
Disable2faWithDelay = false,
RedirectOldSubdomain = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.Site;
import com.pulumi.filescom.SiteArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleSite = new Site("exampleSite", SiteArgs.builder()
.name("My Site")
.subdomain("mysite")
.domain("my-custom-domain.com")
.domainHstsHeader(false)
.domainLetsencryptChain("example")
.email("john.doe@files.com")
.replyToEmail("jane.doe@files.com")
.allowBundleNames(false)
.bundleExpiration(1)
.welcomeEmailEnabled(false)
.askAboutOverwrites(false)
.showRequestAccessLink(false)
.alwaysMkdirParents(false)
.welcomeEmailCc("example")
.welcomeEmailSubject("example")
.welcomeCustomText("Welcome to my site!")
.language("en")
.windowsModeFtp(false)
.defaultTimeZone("Pacific Time (US & Canada)")
.desktopApp(false)
.desktopAppSessionIpPinning(false)
.desktopAppSessionLifetime(1)
.mobileApp(false)
.mobileAppSessionIpPinning(false)
.mobileAppSessionLifetime(1)
.folderPermissionsGroupsOnly(false)
.welcomeScreen("user_controlled")
.officeIntegrationAvailable(false)
.officeIntegrationType("example")
.pinAllRemoteServersToSiteRegion(false)
.motdText("example")
.motdUseForFtp(false)
.motdUseForSftp(false)
.disableAllAiFeatures(false)
.aiFeatureAvailability(Map.of("inAppAiAssistant", Map.ofEntries(
Map.entry("siteAdmins", true),
Map.entry("workspaceAdmins", true),
Map.entry("folderAdmins", true),
Map.entry("allUsers", true)
)))
.mcpDcrEnabled(false)
.additionalTextFileTypes("example")
.bundleRequireNote(false)
.bundleSendSharedReceipts(false)
.bundlesDefaultOwnedByPrimaryGroup(false)
.calculateFileChecksumsCrc32(false)
.calculateFileChecksumsMd5(false)
.calculateFileChecksumsSha1(false)
.calculateFileChecksumsSha256(false)
.legacyChecksumsMode(false)
.migrateRemoteServerSyncToSync(false)
.as2MessageRetentionDays(1)
.usernameDisplay("username_only")
.sessionExpiryMinutes(1)
.sslRequired(false)
.sftpInsecureCiphers(false)
.sftpInsecureDiffieHellman(false)
.disableFilesCertificateGeneration(false)
.fedramp(false)
.userLockout(false)
.userLockoutTries(1)
.userLockoutWithin(1)
.userLockoutLockPeriod(1)
.includePasswordInWelcomeEmail(false)
.allowedCountries("US,DE")
.allowedIps("example")
.allowUserLevel2faOverride(false)
.allowUserLevelAllowedIpOverride(false)
.allowUserLevelSslOverride(false)
.disallowedCountries("US,DE")
.daysToRetainBackups(1)
.maxPriorPasswords(1)
.passwordValidityDays(1)
.passwordMinLength(1)
.passwordRequireLetter(false)
.passwordRequireMixed(false)
.passwordRequireSpecial(false)
.passwordRequireNumber(false)
.passwordRequireUnbreached(false)
.requireLogoutFromBundlesAndInboxes(false)
.davUserRootEnabled(false)
.sftpUserRootEnabled(false)
.disablePasswordReset(false)
.immutableFiles(false)
.bundleNotFoundMessage("example")
.bundlePasswordRequired(false)
.bundleRequireRegistration(false)
.bundleRequireShareRecipient(false)
.bundleSendOneTimePasswordToRecipientAtRegistration(false)
.bundleRegistrationNotifications("never")
.bundleActivityNotifications("never")
.bundleUploadReceiptNotifications("never")
.documentEditsInBundleAllowed(false)
.passwordRequirementsApplyToBundles(false)
.preventRootPermissionsForNonSiteAdmins(false)
.restrictRootFolderBehaviorsToSiteAdmins(false)
.rootFolderBehaviorsApplyToWorkspaces(false)
.optOutGlobal(false)
.useProvidedModifiedAt(false)
.customNamespace(false)
.nonSsoGroupsAllowed(false)
.nonSsoUsersAllowed(false)
.sharingEnabled(false)
.snapshotSharingEnabled(false)
.userRequestsEnabled(false)
.userRequestsNotifyAdmins(false)
.davEnabled(false)
.ftpEnabled(false)
.sftpEnabled(false)
.sftpFinalizePartialUploads(false)
.usersCanCreateApiKeys(false)
.usersCanCreateSshKeys(false)
.showUserNotificationsLogInLink(false)
.sftpHostKeyType("default")
.activeSftpHostKeyId(1)
.protocolAccessGroupsOnly(false)
.revokeBundleAccessOnDisableOrDelete(false)
.bundleWatermarkValue(Map.of("key", "example value"))
.groupAdminsCanAddUsers(false)
.groupAdminsCanManageGroupMemberships(false)
.groupAdminsCanDeleteUsers(false)
.groupAdminsCanEnableDisableUsers(false)
.groupAdminsCanModifyUsers(false)
.groupAdminsCanBypassUserLifecycleRules(false)
.groupAdminsCanResetPasswords(false)
.groupAdminsCanSetUserPassword(false)
.bundleRecipientBlacklistFreeEmailDomains(false)
.bundleRecipientBlacklistDomains("example")
.adminsBypassLockedSubfolders(false)
.allowed2faMethodSms(false)
.allowed2faMethodTotp(false)
.allowed2faMethodWebauthn(false)
.allowed2faMethodYubi(false)
.allowed2faMethodEmail(false)
.allowed2faMethodStatic(false)
.allowed2faMethodBypassForFtpSftpDav(false)
.require2fa(false)
.require2faExemptAllSsoUsers(false)
.require2faUserType("`site_admins`")
.color2Top("#000000")
.color2Left("#0066a7")
.color2Link("#d34f5d")
.color2Text("#0066a7")
.color2TopText("#ffffff")
.siteHeader("example")
.siteFooter("example")
.sitePublicHeader("example")
.sitePublicFooter("example")
.loginHelpText("Login page help text.")
.useDedicatedIpsForSmtp(false)
.emailFooterCustomText("Copyright © %Y MyCompany Inc.")
.smtpAddress("smtp.my-mail-server.com")
.smtpAuthentication("plain")
.smtpFrom("me@my-mail-server.com")
.smtpUsername("mail")
.smtpPort(1)
.ldapEnabled(false)
.ldapType("open_ldap")
.ldapHost("ldap.site.com")
.ldapHost2("ldap2.site.com")
.ldapHost3("ldap3.site.com")
.ldapPort(1)
.ldapSecure(false)
.ldapUsername("[ldap username]")
.ldapUsernameField("sAMAccountName")
.ldapDomain("mysite.com")
.ldapUserAction("disabled")
.ldapGroupAction("disabled")
.ldapUserIncludeGroups("example")
.ldapGroupExclusion("example")
.ldapGroupInclusion("example")
.ldapBaseDn("example")
.uploadsViaEmailAuthentication(false)
.icon16Delete(false)
.icon32Delete(false)
.icon48Delete(false)
.icon128Delete(false)
.logoDelete(false)
.bundleWatermarkAttachmentDelete(false)
.loginPageBackgroundImageDelete(false)
.disable2faWithDelay(false)
.redirectOldSubdomain(false)
.build());
}
}
resources:
exampleSite:
type: filescom:Site
name: example_site
properties:
name: My Site
subdomain: mysite
domain: my-custom-domain.com
domainHstsHeader: false
domainLetsencryptChain: example
email: john.doe@files.com
replyToEmail: jane.doe@files.com
allowBundleNames: false
bundleExpiration: 1
welcomeEmailEnabled: false
askAboutOverwrites: false
showRequestAccessLink: false
alwaysMkdirParents: false
welcomeEmailCc: example
welcomeEmailSubject: example
welcomeCustomText: Welcome to my site!
language: en
windowsModeFtp: false
defaultTimeZone: Pacific Time (US & Canada)
desktopApp: false
desktopAppSessionIpPinning: false
desktopAppSessionLifetime: 1
mobileApp: false
mobileAppSessionIpPinning: false
mobileAppSessionLifetime: 1
folderPermissionsGroupsOnly: false
welcomeScreen: user_controlled
officeIntegrationAvailable: false
officeIntegrationType: example
pinAllRemoteServersToSiteRegion: false
motdText: example
motdUseForFtp: false
motdUseForSftp: false
disableAllAiFeatures: false
aiFeatureAvailability:
inAppAiAssistant:
siteAdmins: true
workspaceAdmins: true
folderAdmins: true
allUsers: true
mcpDcrEnabled: false
additionalTextFileTypes:
- example
bundleRequireNote: false
bundleSendSharedReceipts: false
bundlesDefaultOwnedByPrimaryGroup: false
calculateFileChecksumsCrc32: false
calculateFileChecksumsMd5: false
calculateFileChecksumsSha1: false
calculateFileChecksumsSha256: false
legacyChecksumsMode: false
migrateRemoteServerSyncToSync: false
as2MessageRetentionDays: 1
usernameDisplay: username_only
sessionExpiryMinutes: 1
sslRequired: false
sftpInsecureCiphers: false
sftpInsecureDiffieHellman: false
disableFilesCertificateGeneration: false
fedramp: false
userLockout: false
userLockoutTries: 1
userLockoutWithin: 1
userLockoutLockPeriod: 1
includePasswordInWelcomeEmail: false
allowedCountries: US,DE
allowedIps: example
allowUserLevel2faOverride: false
allowUserLevelAllowedIpOverride: false
allowUserLevelSslOverride: false
disallowedCountries: US,DE
daysToRetainBackups: 1
maxPriorPasswords: 1
passwordValidityDays: 1
passwordMinLength: 1
passwordRequireLetter: false
passwordRequireMixed: false
passwordRequireSpecial: false
passwordRequireNumber: false
passwordRequireUnbreached: false
requireLogoutFromBundlesAndInboxes: false
davUserRootEnabled: false
sftpUserRootEnabled: false
disablePasswordReset: false
immutableFiles: false
bundleNotFoundMessage: example
bundlePasswordRequired: false
bundleRequireRegistration: false
bundleRequireShareRecipient: false
bundleSendOneTimePasswordToRecipientAtRegistration: false
bundleRegistrationNotifications: never
bundleActivityNotifications: never
bundleUploadReceiptNotifications: never
documentEditsInBundleAllowed: false
passwordRequirementsApplyToBundles: false
preventRootPermissionsForNonSiteAdmins: false
restrictRootFolderBehaviorsToSiteAdmins: false
rootFolderBehaviorsApplyToWorkspaces: false
optOutGlobal: false
useProvidedModifiedAt: false
customNamespace: false
nonSsoGroupsAllowed: false
nonSsoUsersAllowed: false
sharingEnabled: false
snapshotSharingEnabled: false
userRequestsEnabled: false
userRequestsNotifyAdmins: false
davEnabled: false
ftpEnabled: false
sftpEnabled: false
sftpFinalizePartialUploads: false
usersCanCreateApiKeys: false
usersCanCreateSshKeys: false
showUserNotificationsLogInLink: false
sftpHostKeyType: default
activeSftpHostKeyId: 1
protocolAccessGroupsOnly: false
revokeBundleAccessOnDisableOrDelete: false
bundleWatermarkValue:
key: example value
groupAdminsCanAddUsers: false
groupAdminsCanManageGroupMemberships: false
groupAdminsCanDeleteUsers: false
groupAdminsCanEnableDisableUsers: false
groupAdminsCanModifyUsers: false
groupAdminsCanBypassUserLifecycleRules: false
groupAdminsCanResetPasswords: false
groupAdminsCanSetUserPassword: false
bundleRecipientBlacklistFreeEmailDomains: false
bundleRecipientBlacklistDomains:
- example
adminsBypassLockedSubfolders: false
allowed2faMethodSms: false
allowed2faMethodTotp: false
allowed2faMethodWebauthn: false
allowed2faMethodYubi: false
allowed2faMethodEmail: false
allowed2faMethodStatic: false
allowed2faMethodBypassForFtpSftpDav: false
require2fa: false
require2faExemptAllSsoUsers: false
require2faUserType: '`site_admins`'
color2Top: '#000000'
color2Left: '#0066a7'
color2Link: '#d34f5d'
color2Text: '#0066a7'
color2TopText: '#ffffff'
siteHeader: example
siteFooter: example
sitePublicHeader: example
sitePublicFooter: example
loginHelpText: Login page help text.
useDedicatedIpsForSmtp: false
emailFooterCustomText: Copyright © %Y MyCompany Inc.
smtpAddress: smtp.my-mail-server.com
smtpAuthentication: plain
smtpFrom: me@my-mail-server.com
smtpUsername: mail
smtpPort: 1
ldapEnabled: false
ldapType: open_ldap
ldapHost: ldap.site.com
ldapHost2: ldap2.site.com
ldapHost3: ldap3.site.com
ldapPort: 1
ldapSecure: false
ldapUsername: '[ldap username]'
ldapUsernameField: sAMAccountName
ldapDomain: mysite.com
ldapUserAction: disabled
ldapGroupAction: disabled
ldapUserIncludeGroups: example
ldapGroupExclusion: example
ldapGroupInclusion: example
ldapBaseDn: example
uploadsViaEmailAuthentication: false
icon16Delete: false
icon32Delete: false
icon48Delete: false
icon128Delete: false
logoDelete: false
bundleWatermarkAttachmentDelete: false
loginPageBackgroundImageDelete: false
disable2faWithDelay: false
redirectOldSubdomain: false
pulumi {
required_providers {
filescom = {
source = "pulumi/filescom"
}
}
}
resource "filescom_site" "example_site" {
name = "My Site"
subdomain = "mysite"
domain = "my-custom-domain.com"
domain_hsts_header = false
domain_letsencrypt_chain = "example"
email = "john.doe@files.com"
reply_to_email = "jane.doe@files.com"
allow_bundle_names = false
bundle_expiration = 1
welcome_email_enabled = false
ask_about_overwrites = false
show_request_access_link = false
always_mkdir_parents = false
welcome_email_cc = "example"
welcome_email_subject = "example"
welcome_custom_text = "Welcome to my site!"
language = "en"
windows_mode_ftp = false
default_time_zone = "Pacific Time (US & Canada)"
desktop_app = false
desktop_app_session_ip_pinning = false
desktop_app_session_lifetime = 1
mobile_app = false
mobile_app_session_ip_pinning = false
mobile_app_session_lifetime = 1
folder_permissions_groups_only = false
welcome_screen = "user_controlled"
office_integration_available = false
office_integration_type = "example"
pin_all_remote_servers_to_site_region = false
motd_text = "example"
motd_use_for_ftp = false
motd_use_for_sftp = false
disable_all_ai_features = false
ai_feature_availability = {
"inAppAiAssistant" = {
"siteAdmins" = true
"workspaceAdmins" = true
"folderAdmins" = true
"allUsers" = true
}
}
mcp_dcr_enabled = false
additional_text_file_types = ["example"]
bundle_require_note = false
bundle_send_shared_receipts = false
bundles_default_owned_by_primary_group = false
calculate_file_checksums_crc32 = false
calculate_file_checksums_md5 = false
calculate_file_checksums_sha1 = false
calculate_file_checksums_sha256 = false
legacy_checksums_mode = false
migrate_remote_server_sync_to_sync = false
as2_message_retention_days = 1
username_display = "username_only"
session_expiry_minutes = 1
ssl_required = false
sftp_insecure_ciphers = false
sftp_insecure_diffie_hellman = false
disable_files_certificate_generation = false
fedramp = false
user_lockout = false
user_lockout_tries = 1
user_lockout_within = 1
user_lockout_lock_period = 1
include_password_in_welcome_email = false
allowed_countries = "US,DE"
allowed_ips = "example"
allow_user_level2fa_override = false
allow_user_level_allowed_ip_override = false
allow_user_level_ssl_override = false
disallowed_countries = "US,DE"
days_to_retain_backups = 1
max_prior_passwords = 1
password_validity_days = 1
password_min_length = 1
password_require_letter = false
password_require_mixed = false
password_require_special = false
password_require_number = false
password_require_unbreached = false
require_logout_from_bundles_and_inboxes = false
dav_user_root_enabled = false
sftp_user_root_enabled = false
disable_password_reset = false
immutable_files = false
bundle_not_found_message = "example"
bundle_password_required = false
bundle_require_registration = false
bundle_require_share_recipient = false
bundle_send_one_time_password_to_recipient_at_registration = false
bundle_registration_notifications = "never"
bundle_activity_notifications = "never"
bundle_upload_receipt_notifications = "never"
document_edits_in_bundle_allowed = false
password_requirements_apply_to_bundles = false
prevent_root_permissions_for_non_site_admins = false
restrict_root_folder_behaviors_to_site_admins = false
root_folder_behaviors_apply_to_workspaces = false
opt_out_global = false
use_provided_modified_at = false
custom_namespace = false
non_sso_groups_allowed = false
non_sso_users_allowed = false
sharing_enabled = false
snapshot_sharing_enabled = false
user_requests_enabled = false
user_requests_notify_admins = false
dav_enabled = false
ftp_enabled = false
sftp_enabled = false
sftp_finalize_partial_uploads = false
users_can_create_api_keys = false
users_can_create_ssh_keys = false
show_user_notifications_log_in_link = false
sftp_host_key_type = "default"
active_sftp_host_key_id = 1
protocol_access_groups_only = false
revoke_bundle_access_on_disable_or_delete = false
bundle_watermark_value = {
"key" = "example value"
}
group_admins_can_add_users = false
group_admins_can_manage_group_memberships = false
group_admins_can_delete_users = false
group_admins_can_enable_disable_users = false
group_admins_can_modify_users = false
group_admins_can_bypass_user_lifecycle_rules = false
group_admins_can_reset_passwords = false
group_admins_can_set_user_password = false
bundle_recipient_blacklist_free_email_domains = false
bundle_recipient_blacklist_domains = ["example"]
admins_bypass_locked_subfolders = false
allowed2fa_method_sms = false
allowed2fa_method_totp = false
allowed2fa_method_webauthn = false
allowed2fa_method_yubi = false
allowed2fa_method_email = false
allowed2fa_method_static = false
allowed2fa_method_bypass_for_ftp_sftp_dav = false
require2fa = false
require2fa_exempt_all_sso_users = false
require2fa_user_type = "`site_admins`"
color2_top = "#000000"
color2_left = "#0066a7"
color2_link = "#d34f5d"
color2_text = "#0066a7"
color2_top_text = "#ffffff"
site_header = "example"
site_footer = "example"
site_public_header = "example"
site_public_footer = "example"
login_help_text = "Login page help text."
use_dedicated_ips_for_smtp = false
email_footer_custom_text = "Copyright © %Y MyCompany Inc."
smtp_address = "smtp.my-mail-server.com"
smtp_authentication = "plain"
smtp_from = "me@my-mail-server.com"
smtp_username = "mail"
smtp_port = 1
ldap_enabled = false
ldap_type = "open_ldap"
ldap_host = "ldap.site.com"
ldap_host2 = "ldap2.site.com"
ldap_host3 = "ldap3.site.com"
ldap_port = 1
ldap_secure = false
ldap_username = "[ldap username]"
ldap_username_field = "sAMAccountName"
ldap_domain = "mysite.com"
ldap_user_action = "disabled"
ldap_group_action = "disabled"
ldap_user_include_groups = "example"
ldap_group_exclusion = "example"
ldap_group_inclusion = "example"
ldap_base_dn = "example"
uploads_via_email_authentication = false
icon16_delete = false
icon32_delete = false
icon48_delete = false
icon128_delete = false
logo_delete = false
bundle_watermark_attachment_delete = false
login_page_background_image_delete = false
disable2fa_with_delay = false
redirect_old_subdomain = false
}
Create Site Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Site(name: string, args?: SiteArgs, opts?: CustomResourceOptions);@overload
def Site(resource_name: str,
args: Optional[SiteArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Site(resource_name: str,
opts: Optional[ResourceOptions] = None,
active_sftp_host_key_id: Optional[int] = None,
additional_text_file_types: Optional[Sequence[str]] = None,
admins_bypass_locked_subfolders: Optional[bool] = None,
ai_feature_availability: Optional[Any] = None,
allow_bundle_names: Optional[bool] = None,
allow_user_level2fa_override: Optional[bool] = None,
allow_user_level_allowed_ip_override: Optional[bool] = None,
allow_user_level_ssl_override: Optional[bool] = None,
allowed2fa_method_bypass_for_ftp_sftp_dav: Optional[bool] = None,
allowed2fa_method_email: Optional[bool] = None,
allowed2fa_method_sms: Optional[bool] = None,
allowed2fa_method_static: Optional[bool] = None,
allowed2fa_method_totp: Optional[bool] = None,
allowed2fa_method_webauthn: Optional[bool] = None,
allowed2fa_method_yubi: Optional[bool] = None,
allowed_countries: Optional[str] = None,
allowed_ips: Optional[str] = None,
always_mkdir_parents: Optional[bool] = None,
as2_message_retention_days: Optional[int] = None,
ask_about_overwrites: Optional[bool] = None,
bundle_activity_notifications: Optional[str] = None,
bundle_expiration: Optional[int] = None,
bundle_not_found_message: Optional[str] = None,
bundle_password_required: Optional[bool] = None,
bundle_recipient_blacklist_domains: Optional[Sequence[str]] = None,
bundle_recipient_blacklist_free_email_domains: Optional[bool] = None,
bundle_registration_notifications: Optional[str] = None,
bundle_require_note: Optional[bool] = None,
bundle_require_registration: Optional[bool] = None,
bundle_require_share_recipient: Optional[bool] = None,
bundle_send_one_time_password_to_recipient_at_registration: Optional[bool] = None,
bundle_send_shared_receipts: Optional[bool] = None,
bundle_upload_receipt_notifications: Optional[str] = None,
bundle_watermark_value: Optional[Any] = None,
bundles_default_owned_by_primary_group: Optional[bool] = None,
calculate_file_checksums_crc32: Optional[bool] = None,
calculate_file_checksums_md5: Optional[bool] = None,
calculate_file_checksums_sha1: Optional[bool] = None,
calculate_file_checksums_sha256: Optional[bool] = None,
color2_left: Optional[str] = None,
color2_link: Optional[str] = None,
color2_text: Optional[str] = None,
color2_top: Optional[str] = None,
color2_top_text: Optional[str] = None,
custom_namespace: Optional[bool] = None,
dav_enabled: Optional[bool] = None,
dav_user_root_enabled: Optional[bool] = None,
days_to_retain_backups: Optional[int] = None,
default_time_zone: Optional[str] = None,
desktop_app: Optional[bool] = None,
desktop_app_session_ip_pinning: Optional[bool] = None,
desktop_app_session_lifetime: Optional[int] = None,
disable_all_ai_features: Optional[bool] = None,
disable_files_certificate_generation: Optional[bool] = None,
disable_password_reset: Optional[bool] = None,
disallowed_countries: Optional[str] = None,
document_edits_in_bundle_allowed: Optional[bool] = None,
domain: Optional[str] = None,
domain_hsts_header: Optional[bool] = None,
domain_letsencrypt_chain: Optional[str] = None,
email: Optional[str] = None,
email_footer_custom_text: Optional[str] = None,
fedramp: Optional[bool] = None,
folder_permissions_groups_only: Optional[bool] = None,
ftp_enabled: Optional[bool] = None,
group_admins_can_add_users: Optional[bool] = None,
group_admins_can_bypass_user_lifecycle_rules: Optional[bool] = None,
group_admins_can_delete_users: Optional[bool] = None,
group_admins_can_enable_disable_users: Optional[bool] = None,
group_admins_can_manage_group_memberships: Optional[bool] = None,
group_admins_can_modify_users: Optional[bool] = None,
group_admins_can_reset_passwords: Optional[bool] = None,
group_admins_can_set_user_password: Optional[bool] = None,
include_password_in_welcome_email: Optional[bool] = None,
language: Optional[str] = None,
ldap_base_dn: Optional[str] = None,
ldap_domain: Optional[str] = None,
ldap_enabled: Optional[bool] = None,
ldap_group_action: Optional[str] = None,
ldap_group_exclusion: Optional[str] = None,
ldap_group_inclusion: Optional[str] = None,
ldap_host: Optional[str] = None,
ldap_host2: Optional[str] = None,
ldap_host3: Optional[str] = None,
ldap_port: Optional[int] = None,
ldap_secure: Optional[bool] = None,
ldap_type: Optional[str] = None,
ldap_user_action: Optional[str] = None,
ldap_user_include_groups: Optional[str] = None,
ldap_username: Optional[str] = None,
ldap_username_field: Optional[str] = None,
legacy_checksums_mode: Optional[bool] = None,
login_help_text: Optional[str] = None,
max_prior_passwords: Optional[int] = None,
mcp_dcr_enabled: Optional[bool] = None,
migrate_remote_server_sync_to_sync: Optional[bool] = None,
mobile_app: Optional[bool] = None,
mobile_app_session_ip_pinning: Optional[bool] = None,
mobile_app_session_lifetime: Optional[int] = None,
motd_text: Optional[str] = None,
motd_use_for_ftp: Optional[bool] = None,
motd_use_for_sftp: Optional[bool] = None,
name: Optional[str] = None,
non_sso_groups_allowed: Optional[bool] = None,
non_sso_users_allowed: Optional[bool] = None,
office_integration_available: Optional[bool] = None,
office_integration_type: Optional[str] = None,
opt_out_global: Optional[bool] = None,
password_min_length: Optional[int] = None,
password_require_letter: Optional[bool] = None,
password_require_mixed: Optional[bool] = None,
password_require_number: Optional[bool] = None,
password_require_special: Optional[bool] = None,
password_require_unbreached: Optional[bool] = None,
password_requirements_apply_to_bundles: Optional[bool] = None,
password_validity_days: Optional[int] = None,
pin_all_remote_servers_to_site_region: Optional[bool] = None,
prevent_root_permissions_for_non_site_admins: Optional[bool] = None,
protocol_access_groups_only: Optional[bool] = None,
reply_to_email: Optional[str] = None,
require2fa: Optional[bool] = None,
require2fa_exempt_all_sso_users: Optional[bool] = None,
require2fa_user_type: Optional[str] = None,
require_logout_from_bundles_and_inboxes: Optional[bool] = None,
restrict_root_folder_behaviors_to_site_admins: Optional[bool] = None,
revoke_bundle_access_on_disable_or_delete: Optional[bool] = None,
root_folder_behaviors_apply_to_workspaces: Optional[bool] = None,
session_expiry_minutes: Optional[int] = None,
sftp_enabled: Optional[bool] = None,
sftp_finalize_partial_uploads: Optional[bool] = None,
sftp_host_key_type: Optional[str] = None,
sftp_insecure_ciphers: Optional[bool] = None,
sftp_insecure_diffie_hellman: Optional[bool] = None,
sftp_user_root_enabled: Optional[bool] = None,
sharing_enabled: Optional[bool] = None,
show_request_access_link: Optional[bool] = None,
show_user_notifications_log_in_link: Optional[bool] = None,
site_footer: Optional[str] = None,
site_header: Optional[str] = None,
site_public_footer: Optional[str] = None,
site_public_header: Optional[str] = None,
smtp_address: Optional[str] = None,
smtp_authentication: Optional[str] = None,
smtp_from: Optional[str] = None,
smtp_port: Optional[int] = None,
smtp_username: Optional[str] = None,
snapshot_sharing_enabled: Optional[bool] = None,
ssl_required: Optional[bool] = None,
subdomain: Optional[str] = None,
uploads_via_email_authentication: Optional[bool] = None,
use_dedicated_ips_for_smtp: Optional[bool] = None,
use_provided_modified_at: Optional[bool] = None,
user_lockout: Optional[bool] = None,
user_lockout_lock_period: Optional[int] = None,
user_lockout_tries: Optional[int] = None,
user_lockout_within: Optional[int] = None,
user_requests_enabled: Optional[bool] = None,
user_requests_notify_admins: Optional[bool] = None,
username_display: Optional[str] = None,
users_can_create_api_keys: Optional[bool] = None,
users_can_create_ssh_keys: Optional[bool] = None,
welcome_custom_text: Optional[str] = None,
welcome_email_cc: Optional[str] = None,
welcome_email_enabled: Optional[bool] = None,
welcome_email_subject: Optional[str] = None,
welcome_screen: Optional[str] = None,
windows_mode_ftp: Optional[bool] = None)func NewSite(ctx *Context, name string, args *SiteArgs, opts ...ResourceOption) (*Site, error)public Site(string name, SiteArgs? args = null, CustomResourceOptions? opts = null)type: filescom:Site
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "filescom_site" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SiteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SiteArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SiteArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SiteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SiteArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var siteResource = new Filescom.Site("siteResource", new()
{
ActiveSftpHostKeyId = 0,
AdditionalTextFileTypes = new[]
{
"string",
},
AdminsBypassLockedSubfolders = false,
AiFeatureAvailability = "any",
AllowBundleNames = false,
AllowUserLevel2faOverride = false,
AllowUserLevelAllowedIpOverride = false,
AllowUserLevelSslOverride = false,
Allowed2faMethodBypassForFtpSftpDav = false,
Allowed2faMethodEmail = false,
Allowed2faMethodSms = false,
Allowed2faMethodStatic = false,
Allowed2faMethodTotp = false,
Allowed2faMethodWebauthn = false,
Allowed2faMethodYubi = false,
AllowedCountries = "string",
AllowedIps = "string",
AlwaysMkdirParents = false,
As2MessageRetentionDays = 0,
AskAboutOverwrites = false,
BundleActivityNotifications = "string",
BundleExpiration = 0,
BundleNotFoundMessage = "string",
BundlePasswordRequired = false,
BundleRecipientBlacklistDomains = new[]
{
"string",
},
BundleRecipientBlacklistFreeEmailDomains = false,
BundleRegistrationNotifications = "string",
BundleRequireNote = false,
BundleRequireRegistration = false,
BundleRequireShareRecipient = false,
BundleSendOneTimePasswordToRecipientAtRegistration = false,
BundleSendSharedReceipts = false,
BundleUploadReceiptNotifications = "string",
BundleWatermarkValue = "any",
BundlesDefaultOwnedByPrimaryGroup = false,
CalculateFileChecksumsCrc32 = false,
CalculateFileChecksumsMd5 = false,
CalculateFileChecksumsSha1 = false,
CalculateFileChecksumsSha256 = false,
Color2Left = "string",
Color2Link = "string",
Color2Text = "string",
Color2Top = "string",
Color2TopText = "string",
CustomNamespace = false,
DavEnabled = false,
DavUserRootEnabled = false,
DaysToRetainBackups = 0,
DefaultTimeZone = "string",
DesktopApp = false,
DesktopAppSessionIpPinning = false,
DesktopAppSessionLifetime = 0,
DisableAllAiFeatures = false,
DisableFilesCertificateGeneration = false,
DisablePasswordReset = false,
DisallowedCountries = "string",
DocumentEditsInBundleAllowed = false,
Domain = "string",
DomainHstsHeader = false,
DomainLetsencryptChain = "string",
Email = "string",
EmailFooterCustomText = "string",
Fedramp = false,
FolderPermissionsGroupsOnly = false,
FtpEnabled = false,
GroupAdminsCanAddUsers = false,
GroupAdminsCanBypassUserLifecycleRules = false,
GroupAdminsCanDeleteUsers = false,
GroupAdminsCanEnableDisableUsers = false,
GroupAdminsCanManageGroupMemberships = false,
GroupAdminsCanModifyUsers = false,
GroupAdminsCanResetPasswords = false,
GroupAdminsCanSetUserPassword = false,
IncludePasswordInWelcomeEmail = false,
Language = "string",
LdapBaseDn = "string",
LdapDomain = "string",
LdapEnabled = false,
LdapGroupAction = "string",
LdapGroupExclusion = "string",
LdapGroupInclusion = "string",
LdapHost = "string",
LdapHost2 = "string",
LdapHost3 = "string",
LdapPort = 0,
LdapSecure = false,
LdapType = "string",
LdapUserAction = "string",
LdapUserIncludeGroups = "string",
LdapUsername = "string",
LdapUsernameField = "string",
LegacyChecksumsMode = false,
LoginHelpText = "string",
MaxPriorPasswords = 0,
McpDcrEnabled = false,
MigrateRemoteServerSyncToSync = false,
MobileApp = false,
MobileAppSessionIpPinning = false,
MobileAppSessionLifetime = 0,
MotdText = "string",
MotdUseForFtp = false,
MotdUseForSftp = false,
Name = "string",
NonSsoGroupsAllowed = false,
NonSsoUsersAllowed = false,
OfficeIntegrationAvailable = false,
OfficeIntegrationType = "string",
OptOutGlobal = false,
PasswordMinLength = 0,
PasswordRequireLetter = false,
PasswordRequireMixed = false,
PasswordRequireNumber = false,
PasswordRequireSpecial = false,
PasswordRequireUnbreached = false,
PasswordRequirementsApplyToBundles = false,
PasswordValidityDays = 0,
PinAllRemoteServersToSiteRegion = false,
PreventRootPermissionsForNonSiteAdmins = false,
ProtocolAccessGroupsOnly = false,
ReplyToEmail = "string",
Require2fa = false,
Require2faExemptAllSsoUsers = false,
Require2faUserType = "string",
RequireLogoutFromBundlesAndInboxes = false,
RestrictRootFolderBehaviorsToSiteAdmins = false,
RevokeBundleAccessOnDisableOrDelete = false,
RootFolderBehaviorsApplyToWorkspaces = false,
SessionExpiryMinutes = 0,
SftpEnabled = false,
SftpFinalizePartialUploads = false,
SftpHostKeyType = "string",
SftpInsecureCiphers = false,
SftpInsecureDiffieHellman = false,
SftpUserRootEnabled = false,
SharingEnabled = false,
ShowRequestAccessLink = false,
ShowUserNotificationsLogInLink = false,
SiteFooter = "string",
SiteHeader = "string",
SitePublicFooter = "string",
SitePublicHeader = "string",
SmtpAddress = "string",
SmtpAuthentication = "string",
SmtpFrom = "string",
SmtpPort = 0,
SmtpUsername = "string",
SnapshotSharingEnabled = false,
SslRequired = false,
Subdomain = "string",
UploadsViaEmailAuthentication = false,
UseDedicatedIpsForSmtp = false,
UseProvidedModifiedAt = false,
UserLockout = false,
UserLockoutLockPeriod = 0,
UserLockoutTries = 0,
UserLockoutWithin = 0,
UserRequestsEnabled = false,
UserRequestsNotifyAdmins = false,
UsernameDisplay = "string",
UsersCanCreateApiKeys = false,
UsersCanCreateSshKeys = false,
WelcomeCustomText = "string",
WelcomeEmailCc = "string",
WelcomeEmailEnabled = false,
WelcomeEmailSubject = "string",
WelcomeScreen = "string",
WindowsModeFtp = false,
});
example, err := filescom.NewSite(ctx, "siteResource", &filescom.SiteArgs{
ActiveSftpHostKeyId: pulumi.Int(0),
AdditionalTextFileTypes: pulumi.StringArray{
pulumi.String("string"),
},
AdminsBypassLockedSubfolders: pulumi.Bool(false),
AiFeatureAvailability: pulumi.Any("any"),
AllowBundleNames: pulumi.Bool(false),
AllowUserLevel2faOverride: pulumi.Bool(false),
AllowUserLevelAllowedIpOverride: pulumi.Bool(false),
AllowUserLevelSslOverride: pulumi.Bool(false),
Allowed2faMethodBypassForFtpSftpDav: pulumi.Bool(false),
Allowed2faMethodEmail: pulumi.Bool(false),
Allowed2faMethodSms: pulumi.Bool(false),
Allowed2faMethodStatic: pulumi.Bool(false),
Allowed2faMethodTotp: pulumi.Bool(false),
Allowed2faMethodWebauthn: pulumi.Bool(false),
Allowed2faMethodYubi: pulumi.Bool(false),
AllowedCountries: pulumi.String("string"),
AllowedIps: pulumi.String("string"),
AlwaysMkdirParents: pulumi.Bool(false),
As2MessageRetentionDays: pulumi.Int(0),
AskAboutOverwrites: pulumi.Bool(false),
BundleActivityNotifications: pulumi.String("string"),
BundleExpiration: pulumi.Int(0),
BundleNotFoundMessage: pulumi.String("string"),
BundlePasswordRequired: pulumi.Bool(false),
BundleRecipientBlacklistDomains: pulumi.StringArray{
pulumi.String("string"),
},
BundleRecipientBlacklistFreeEmailDomains: pulumi.Bool(false),
BundleRegistrationNotifications: pulumi.String("string"),
BundleRequireNote: pulumi.Bool(false),
BundleRequireRegistration: pulumi.Bool(false),
BundleRequireShareRecipient: pulumi.Bool(false),
BundleSendOneTimePasswordToRecipientAtRegistration: pulumi.Bool(false),
BundleSendSharedReceipts: pulumi.Bool(false),
BundleUploadReceiptNotifications: pulumi.String("string"),
BundleWatermarkValue: pulumi.Any("any"),
BundlesDefaultOwnedByPrimaryGroup: pulumi.Bool(false),
CalculateFileChecksumsCrc32: pulumi.Bool(false),
CalculateFileChecksumsMd5: pulumi.Bool(false),
CalculateFileChecksumsSha1: pulumi.Bool(false),
CalculateFileChecksumsSha256: pulumi.Bool(false),
Color2Left: pulumi.String("string"),
Color2Link: pulumi.String("string"),
Color2Text: pulumi.String("string"),
Color2Top: pulumi.String("string"),
Color2TopText: pulumi.String("string"),
CustomNamespace: pulumi.Bool(false),
DavEnabled: pulumi.Bool(false),
DavUserRootEnabled: pulumi.Bool(false),
DaysToRetainBackups: pulumi.Int(0),
DefaultTimeZone: pulumi.String("string"),
DesktopApp: pulumi.Bool(false),
DesktopAppSessionIpPinning: pulumi.Bool(false),
DesktopAppSessionLifetime: pulumi.Int(0),
DisableAllAiFeatures: pulumi.Bool(false),
DisableFilesCertificateGeneration: pulumi.Bool(false),
DisablePasswordReset: pulumi.Bool(false),
DisallowedCountries: pulumi.String("string"),
DocumentEditsInBundleAllowed: pulumi.Bool(false),
Domain: pulumi.String("string"),
DomainHstsHeader: pulumi.Bool(false),
DomainLetsencryptChain: pulumi.String("string"),
Email: pulumi.String("string"),
EmailFooterCustomText: pulumi.String("string"),
Fedramp: pulumi.Bool(false),
FolderPermissionsGroupsOnly: pulumi.Bool(false),
FtpEnabled: pulumi.Bool(false),
GroupAdminsCanAddUsers: pulumi.Bool(false),
GroupAdminsCanBypassUserLifecycleRules: pulumi.Bool(false),
GroupAdminsCanDeleteUsers: pulumi.Bool(false),
GroupAdminsCanEnableDisableUsers: pulumi.Bool(false),
GroupAdminsCanManageGroupMemberships: pulumi.Bool(false),
GroupAdminsCanModifyUsers: pulumi.Bool(false),
GroupAdminsCanResetPasswords: pulumi.Bool(false),
GroupAdminsCanSetUserPassword: pulumi.Bool(false),
IncludePasswordInWelcomeEmail: pulumi.Bool(false),
Language: pulumi.String("string"),
LdapBaseDn: pulumi.String("string"),
LdapDomain: pulumi.String("string"),
LdapEnabled: pulumi.Bool(false),
LdapGroupAction: pulumi.String("string"),
LdapGroupExclusion: pulumi.String("string"),
LdapGroupInclusion: pulumi.String("string"),
LdapHost: pulumi.String("string"),
LdapHost2: pulumi.String("string"),
LdapHost3: pulumi.String("string"),
LdapPort: pulumi.Int(0),
LdapSecure: pulumi.Bool(false),
LdapType: pulumi.String("string"),
LdapUserAction: pulumi.String("string"),
LdapUserIncludeGroups: pulumi.String("string"),
LdapUsername: pulumi.String("string"),
LdapUsernameField: pulumi.String("string"),
LegacyChecksumsMode: pulumi.Bool(false),
LoginHelpText: pulumi.String("string"),
MaxPriorPasswords: pulumi.Int(0),
McpDcrEnabled: pulumi.Bool(false),
MigrateRemoteServerSyncToSync: pulumi.Bool(false),
MobileApp: pulumi.Bool(false),
MobileAppSessionIpPinning: pulumi.Bool(false),
MobileAppSessionLifetime: pulumi.Int(0),
MotdText: pulumi.String("string"),
MotdUseForFtp: pulumi.Bool(false),
MotdUseForSftp: pulumi.Bool(false),
Name: pulumi.String("string"),
NonSsoGroupsAllowed: pulumi.Bool(false),
NonSsoUsersAllowed: pulumi.Bool(false),
OfficeIntegrationAvailable: pulumi.Bool(false),
OfficeIntegrationType: pulumi.String("string"),
OptOutGlobal: pulumi.Bool(false),
PasswordMinLength: pulumi.Int(0),
PasswordRequireLetter: pulumi.Bool(false),
PasswordRequireMixed: pulumi.Bool(false),
PasswordRequireNumber: pulumi.Bool(false),
PasswordRequireSpecial: pulumi.Bool(false),
PasswordRequireUnbreached: pulumi.Bool(false),
PasswordRequirementsApplyToBundles: pulumi.Bool(false),
PasswordValidityDays: pulumi.Int(0),
PinAllRemoteServersToSiteRegion: pulumi.Bool(false),
PreventRootPermissionsForNonSiteAdmins: pulumi.Bool(false),
ProtocolAccessGroupsOnly: pulumi.Bool(false),
ReplyToEmail: pulumi.String("string"),
Require2fa: pulumi.Bool(false),
Require2faExemptAllSsoUsers: pulumi.Bool(false),
Require2faUserType: pulumi.String("string"),
RequireLogoutFromBundlesAndInboxes: pulumi.Bool(false),
RestrictRootFolderBehaviorsToSiteAdmins: pulumi.Bool(false),
RevokeBundleAccessOnDisableOrDelete: pulumi.Bool(false),
RootFolderBehaviorsApplyToWorkspaces: pulumi.Bool(false),
SessionExpiryMinutes: pulumi.Int(0),
SftpEnabled: pulumi.Bool(false),
SftpFinalizePartialUploads: pulumi.Bool(false),
SftpHostKeyType: pulumi.String("string"),
SftpInsecureCiphers: pulumi.Bool(false),
SftpInsecureDiffieHellman: pulumi.Bool(false),
SftpUserRootEnabled: pulumi.Bool(false),
SharingEnabled: pulumi.Bool(false),
ShowRequestAccessLink: pulumi.Bool(false),
ShowUserNotificationsLogInLink: pulumi.Bool(false),
SiteFooter: pulumi.String("string"),
SiteHeader: pulumi.String("string"),
SitePublicFooter: pulumi.String("string"),
SitePublicHeader: pulumi.String("string"),
SmtpAddress: pulumi.String("string"),
SmtpAuthentication: pulumi.String("string"),
SmtpFrom: pulumi.String("string"),
SmtpPort: pulumi.Int(0),
SmtpUsername: pulumi.String("string"),
SnapshotSharingEnabled: pulumi.Bool(false),
SslRequired: pulumi.Bool(false),
Subdomain: pulumi.String("string"),
UploadsViaEmailAuthentication: pulumi.Bool(false),
UseDedicatedIpsForSmtp: pulumi.Bool(false),
UseProvidedModifiedAt: pulumi.Bool(false),
UserLockout: pulumi.Bool(false),
UserLockoutLockPeriod: pulumi.Int(0),
UserLockoutTries: pulumi.Int(0),
UserLockoutWithin: pulumi.Int(0),
UserRequestsEnabled: pulumi.Bool(false),
UserRequestsNotifyAdmins: pulumi.Bool(false),
UsernameDisplay: pulumi.String("string"),
UsersCanCreateApiKeys: pulumi.Bool(false),
UsersCanCreateSshKeys: pulumi.Bool(false),
WelcomeCustomText: pulumi.String("string"),
WelcomeEmailCc: pulumi.String("string"),
WelcomeEmailEnabled: pulumi.Bool(false),
WelcomeEmailSubject: pulumi.String("string"),
WelcomeScreen: pulumi.String("string"),
WindowsModeFtp: pulumi.Bool(false),
})
resource "filescom_site" "siteResource" {
lifecycle {
create_before_destroy = true
}
active_sftp_host_key_id = 0
additional_text_file_types = ["string"]
admins_bypass_locked_subfolders = false
ai_feature_availability = "any"
allow_bundle_names = false
allow_user_level2fa_override = false
allow_user_level_allowed_ip_override = false
allow_user_level_ssl_override = false
allowed2fa_method_bypass_for_ftp_sftp_dav = false
allowed2fa_method_email = false
allowed2fa_method_sms = false
allowed2fa_method_static = false
allowed2fa_method_totp = false
allowed2fa_method_webauthn = false
allowed2fa_method_yubi = false
allowed_countries = "string"
allowed_ips = "string"
always_mkdir_parents = false
as2_message_retention_days = 0
ask_about_overwrites = false
bundle_activity_notifications = "string"
bundle_expiration = 0
bundle_not_found_message = "string"
bundle_password_required = false
bundle_recipient_blacklist_domains = ["string"]
bundle_recipient_blacklist_free_email_domains = false
bundle_registration_notifications = "string"
bundle_require_note = false
bundle_require_registration = false
bundle_require_share_recipient = false
bundle_send_one_time_password_to_recipient_at_registration = false
bundle_send_shared_receipts = false
bundle_upload_receipt_notifications = "string"
bundle_watermark_value = "any"
bundles_default_owned_by_primary_group = false
calculate_file_checksums_crc32 = false
calculate_file_checksums_md5 = false
calculate_file_checksums_sha1 = false
calculate_file_checksums_sha256 = false
color2_left = "string"
color2_link = "string"
color2_text = "string"
color2_top = "string"
color2_top_text = "string"
custom_namespace = false
dav_enabled = false
dav_user_root_enabled = false
days_to_retain_backups = 0
default_time_zone = "string"
desktop_app = false
desktop_app_session_ip_pinning = false
desktop_app_session_lifetime = 0
disable_all_ai_features = false
disable_files_certificate_generation = false
disable_password_reset = false
disallowed_countries = "string"
document_edits_in_bundle_allowed = false
domain = "string"
domain_hsts_header = false
domain_letsencrypt_chain = "string"
email = "string"
email_footer_custom_text = "string"
fedramp = false
folder_permissions_groups_only = false
ftp_enabled = false
group_admins_can_add_users = false
group_admins_can_bypass_user_lifecycle_rules = false
group_admins_can_delete_users = false
group_admins_can_enable_disable_users = false
group_admins_can_manage_group_memberships = false
group_admins_can_modify_users = false
group_admins_can_reset_passwords = false
group_admins_can_set_user_password = false
include_password_in_welcome_email = false
language = "string"
ldap_base_dn = "string"
ldap_domain = "string"
ldap_enabled = false
ldap_group_action = "string"
ldap_group_exclusion = "string"
ldap_group_inclusion = "string"
ldap_host = "string"
ldap_host2 = "string"
ldap_host3 = "string"
ldap_port = 0
ldap_secure = false
ldap_type = "string"
ldap_user_action = "string"
ldap_user_include_groups = "string"
ldap_username = "string"
ldap_username_field = "string"
legacy_checksums_mode = false
login_help_text = "string"
max_prior_passwords = 0
mcp_dcr_enabled = false
migrate_remote_server_sync_to_sync = false
mobile_app = false
mobile_app_session_ip_pinning = false
mobile_app_session_lifetime = 0
motd_text = "string"
motd_use_for_ftp = false
motd_use_for_sftp = false
name = "string"
non_sso_groups_allowed = false
non_sso_users_allowed = false
office_integration_available = false
office_integration_type = "string"
opt_out_global = false
password_min_length = 0
password_require_letter = false
password_require_mixed = false
password_require_number = false
password_require_special = false
password_require_unbreached = false
password_requirements_apply_to_bundles = false
password_validity_days = 0
pin_all_remote_servers_to_site_region = false
prevent_root_permissions_for_non_site_admins = false
protocol_access_groups_only = false
reply_to_email = "string"
require2fa = false
require2fa_exempt_all_sso_users = false
require2fa_user_type = "string"
require_logout_from_bundles_and_inboxes = false
restrict_root_folder_behaviors_to_site_admins = false
revoke_bundle_access_on_disable_or_delete = false
root_folder_behaviors_apply_to_workspaces = false
session_expiry_minutes = 0
sftp_enabled = false
sftp_finalize_partial_uploads = false
sftp_host_key_type = "string"
sftp_insecure_ciphers = false
sftp_insecure_diffie_hellman = false
sftp_user_root_enabled = false
sharing_enabled = false
show_request_access_link = false
show_user_notifications_log_in_link = false
site_footer = "string"
site_header = "string"
site_public_footer = "string"
site_public_header = "string"
smtp_address = "string"
smtp_authentication = "string"
smtp_from = "string"
smtp_port = 0
smtp_username = "string"
snapshot_sharing_enabled = false
ssl_required = false
subdomain = "string"
uploads_via_email_authentication = false
use_dedicated_ips_for_smtp = false
use_provided_modified_at = false
user_lockout = false
user_lockout_lock_period = 0
user_lockout_tries = 0
user_lockout_within = 0
user_requests_enabled = false
user_requests_notify_admins = false
username_display = "string"
users_can_create_api_keys = false
users_can_create_ssh_keys = false
welcome_custom_text = "string"
welcome_email_cc = "string"
welcome_email_enabled = false
welcome_email_subject = "string"
welcome_screen = "string"
windows_mode_ftp = false
}
var siteResource = new Site("siteResource", SiteArgs.builder()
.activeSftpHostKeyId(0)
.additionalTextFileTypes("string")
.adminsBypassLockedSubfolders(false)
.aiFeatureAvailability("any")
.allowBundleNames(false)
.allowUserLevel2faOverride(false)
.allowUserLevelAllowedIpOverride(false)
.allowUserLevelSslOverride(false)
.allowed2faMethodBypassForFtpSftpDav(false)
.allowed2faMethodEmail(false)
.allowed2faMethodSms(false)
.allowed2faMethodStatic(false)
.allowed2faMethodTotp(false)
.allowed2faMethodWebauthn(false)
.allowed2faMethodYubi(false)
.allowedCountries("string")
.allowedIps("string")
.alwaysMkdirParents(false)
.as2MessageRetentionDays(0)
.askAboutOverwrites(false)
.bundleActivityNotifications("string")
.bundleExpiration(0)
.bundleNotFoundMessage("string")
.bundlePasswordRequired(false)
.bundleRecipientBlacklistDomains("string")
.bundleRecipientBlacklistFreeEmailDomains(false)
.bundleRegistrationNotifications("string")
.bundleRequireNote(false)
.bundleRequireRegistration(false)
.bundleRequireShareRecipient(false)
.bundleSendOneTimePasswordToRecipientAtRegistration(false)
.bundleSendSharedReceipts(false)
.bundleUploadReceiptNotifications("string")
.bundleWatermarkValue("any")
.bundlesDefaultOwnedByPrimaryGroup(false)
.calculateFileChecksumsCrc32(false)
.calculateFileChecksumsMd5(false)
.calculateFileChecksumsSha1(false)
.calculateFileChecksumsSha256(false)
.color2Left("string")
.color2Link("string")
.color2Text("string")
.color2Top("string")
.color2TopText("string")
.customNamespace(false)
.davEnabled(false)
.davUserRootEnabled(false)
.daysToRetainBackups(0)
.defaultTimeZone("string")
.desktopApp(false)
.desktopAppSessionIpPinning(false)
.desktopAppSessionLifetime(0)
.disableAllAiFeatures(false)
.disableFilesCertificateGeneration(false)
.disablePasswordReset(false)
.disallowedCountries("string")
.documentEditsInBundleAllowed(false)
.domain("string")
.domainHstsHeader(false)
.domainLetsencryptChain("string")
.email("string")
.emailFooterCustomText("string")
.fedramp(false)
.folderPermissionsGroupsOnly(false)
.ftpEnabled(false)
.groupAdminsCanAddUsers(false)
.groupAdminsCanBypassUserLifecycleRules(false)
.groupAdminsCanDeleteUsers(false)
.groupAdminsCanEnableDisableUsers(false)
.groupAdminsCanManageGroupMemberships(false)
.groupAdminsCanModifyUsers(false)
.groupAdminsCanResetPasswords(false)
.groupAdminsCanSetUserPassword(false)
.includePasswordInWelcomeEmail(false)
.language("string")
.ldapBaseDn("string")
.ldapDomain("string")
.ldapEnabled(false)
.ldapGroupAction("string")
.ldapGroupExclusion("string")
.ldapGroupInclusion("string")
.ldapHost("string")
.ldapHost2("string")
.ldapHost3("string")
.ldapPort(0)
.ldapSecure(false)
.ldapType("string")
.ldapUserAction("string")
.ldapUserIncludeGroups("string")
.ldapUsername("string")
.ldapUsernameField("string")
.legacyChecksumsMode(false)
.loginHelpText("string")
.maxPriorPasswords(0)
.mcpDcrEnabled(false)
.migrateRemoteServerSyncToSync(false)
.mobileApp(false)
.mobileAppSessionIpPinning(false)
.mobileAppSessionLifetime(0)
.motdText("string")
.motdUseForFtp(false)
.motdUseForSftp(false)
.name("string")
.nonSsoGroupsAllowed(false)
.nonSsoUsersAllowed(false)
.officeIntegrationAvailable(false)
.officeIntegrationType("string")
.optOutGlobal(false)
.passwordMinLength(0)
.passwordRequireLetter(false)
.passwordRequireMixed(false)
.passwordRequireNumber(false)
.passwordRequireSpecial(false)
.passwordRequireUnbreached(false)
.passwordRequirementsApplyToBundles(false)
.passwordValidityDays(0)
.pinAllRemoteServersToSiteRegion(false)
.preventRootPermissionsForNonSiteAdmins(false)
.protocolAccessGroupsOnly(false)
.replyToEmail("string")
.require2fa(false)
.require2faExemptAllSsoUsers(false)
.require2faUserType("string")
.requireLogoutFromBundlesAndInboxes(false)
.restrictRootFolderBehaviorsToSiteAdmins(false)
.revokeBundleAccessOnDisableOrDelete(false)
.rootFolderBehaviorsApplyToWorkspaces(false)
.sessionExpiryMinutes(0)
.sftpEnabled(false)
.sftpFinalizePartialUploads(false)
.sftpHostKeyType("string")
.sftpInsecureCiphers(false)
.sftpInsecureDiffieHellman(false)
.sftpUserRootEnabled(false)
.sharingEnabled(false)
.showRequestAccessLink(false)
.showUserNotificationsLogInLink(false)
.siteFooter("string")
.siteHeader("string")
.sitePublicFooter("string")
.sitePublicHeader("string")
.smtpAddress("string")
.smtpAuthentication("string")
.smtpFrom("string")
.smtpPort(0)
.smtpUsername("string")
.snapshotSharingEnabled(false)
.sslRequired(false)
.subdomain("string")
.uploadsViaEmailAuthentication(false)
.useDedicatedIpsForSmtp(false)
.useProvidedModifiedAt(false)
.userLockout(false)
.userLockoutLockPeriod(0)
.userLockoutTries(0)
.userLockoutWithin(0)
.userRequestsEnabled(false)
.userRequestsNotifyAdmins(false)
.usernameDisplay("string")
.usersCanCreateApiKeys(false)
.usersCanCreateSshKeys(false)
.welcomeCustomText("string")
.welcomeEmailCc("string")
.welcomeEmailEnabled(false)
.welcomeEmailSubject("string")
.welcomeScreen("string")
.windowsModeFtp(false)
.build());
site_resource = filescom.Site("siteResource",
active_sftp_host_key_id=0,
additional_text_file_types=["string"],
admins_bypass_locked_subfolders=False,
ai_feature_availability="any",
allow_bundle_names=False,
allow_user_level2fa_override=False,
allow_user_level_allowed_ip_override=False,
allow_user_level_ssl_override=False,
allowed2fa_method_bypass_for_ftp_sftp_dav=False,
allowed2fa_method_email=False,
allowed2fa_method_sms=False,
allowed2fa_method_static=False,
allowed2fa_method_totp=False,
allowed2fa_method_webauthn=False,
allowed2fa_method_yubi=False,
allowed_countries="string",
allowed_ips="string",
always_mkdir_parents=False,
as2_message_retention_days=0,
ask_about_overwrites=False,
bundle_activity_notifications="string",
bundle_expiration=0,
bundle_not_found_message="string",
bundle_password_required=False,
bundle_recipient_blacklist_domains=["string"],
bundle_recipient_blacklist_free_email_domains=False,
bundle_registration_notifications="string",
bundle_require_note=False,
bundle_require_registration=False,
bundle_require_share_recipient=False,
bundle_send_one_time_password_to_recipient_at_registration=False,
bundle_send_shared_receipts=False,
bundle_upload_receipt_notifications="string",
bundle_watermark_value="any",
bundles_default_owned_by_primary_group=False,
calculate_file_checksums_crc32=False,
calculate_file_checksums_md5=False,
calculate_file_checksums_sha1=False,
calculate_file_checksums_sha256=False,
color2_left="string",
color2_link="string",
color2_text="string",
color2_top="string",
color2_top_text="string",
custom_namespace=False,
dav_enabled=False,
dav_user_root_enabled=False,
days_to_retain_backups=0,
default_time_zone="string",
desktop_app=False,
desktop_app_session_ip_pinning=False,
desktop_app_session_lifetime=0,
disable_all_ai_features=False,
disable_files_certificate_generation=False,
disable_password_reset=False,
disallowed_countries="string",
document_edits_in_bundle_allowed=False,
domain="string",
domain_hsts_header=False,
domain_letsencrypt_chain="string",
email="string",
email_footer_custom_text="string",
fedramp=False,
folder_permissions_groups_only=False,
ftp_enabled=False,
group_admins_can_add_users=False,
group_admins_can_bypass_user_lifecycle_rules=False,
group_admins_can_delete_users=False,
group_admins_can_enable_disable_users=False,
group_admins_can_manage_group_memberships=False,
group_admins_can_modify_users=False,
group_admins_can_reset_passwords=False,
group_admins_can_set_user_password=False,
include_password_in_welcome_email=False,
language="string",
ldap_base_dn="string",
ldap_domain="string",
ldap_enabled=False,
ldap_group_action="string",
ldap_group_exclusion="string",
ldap_group_inclusion="string",
ldap_host="string",
ldap_host2="string",
ldap_host3="string",
ldap_port=0,
ldap_secure=False,
ldap_type="string",
ldap_user_action="string",
ldap_user_include_groups="string",
ldap_username="string",
ldap_username_field="string",
legacy_checksums_mode=False,
login_help_text="string",
max_prior_passwords=0,
mcp_dcr_enabled=False,
migrate_remote_server_sync_to_sync=False,
mobile_app=False,
mobile_app_session_ip_pinning=False,
mobile_app_session_lifetime=0,
motd_text="string",
motd_use_for_ftp=False,
motd_use_for_sftp=False,
name="string",
non_sso_groups_allowed=False,
non_sso_users_allowed=False,
office_integration_available=False,
office_integration_type="string",
opt_out_global=False,
password_min_length=0,
password_require_letter=False,
password_require_mixed=False,
password_require_number=False,
password_require_special=False,
password_require_unbreached=False,
password_requirements_apply_to_bundles=False,
password_validity_days=0,
pin_all_remote_servers_to_site_region=False,
prevent_root_permissions_for_non_site_admins=False,
protocol_access_groups_only=False,
reply_to_email="string",
require2fa=False,
require2fa_exempt_all_sso_users=False,
require2fa_user_type="string",
require_logout_from_bundles_and_inboxes=False,
restrict_root_folder_behaviors_to_site_admins=False,
revoke_bundle_access_on_disable_or_delete=False,
root_folder_behaviors_apply_to_workspaces=False,
session_expiry_minutes=0,
sftp_enabled=False,
sftp_finalize_partial_uploads=False,
sftp_host_key_type="string",
sftp_insecure_ciphers=False,
sftp_insecure_diffie_hellman=False,
sftp_user_root_enabled=False,
sharing_enabled=False,
show_request_access_link=False,
show_user_notifications_log_in_link=False,
site_footer="string",
site_header="string",
site_public_footer="string",
site_public_header="string",
smtp_address="string",
smtp_authentication="string",
smtp_from="string",
smtp_port=0,
smtp_username="string",
snapshot_sharing_enabled=False,
ssl_required=False,
subdomain="string",
uploads_via_email_authentication=False,
use_dedicated_ips_for_smtp=False,
use_provided_modified_at=False,
user_lockout=False,
user_lockout_lock_period=0,
user_lockout_tries=0,
user_lockout_within=0,
user_requests_enabled=False,
user_requests_notify_admins=False,
username_display="string",
users_can_create_api_keys=False,
users_can_create_ssh_keys=False,
welcome_custom_text="string",
welcome_email_cc="string",
welcome_email_enabled=False,
welcome_email_subject="string",
welcome_screen="string",
windows_mode_ftp=False)
const siteResource = new filescom.Site("siteResource", {
activeSftpHostKeyId: 0,
additionalTextFileTypes: ["string"],
adminsBypassLockedSubfolders: false,
aiFeatureAvailability: "any",
allowBundleNames: false,
allowUserLevel2faOverride: false,
allowUserLevelAllowedIpOverride: false,
allowUserLevelSslOverride: false,
allowed2faMethodBypassForFtpSftpDav: false,
allowed2faMethodEmail: false,
allowed2faMethodSms: false,
allowed2faMethodStatic: false,
allowed2faMethodTotp: false,
allowed2faMethodWebauthn: false,
allowed2faMethodYubi: false,
allowedCountries: "string",
allowedIps: "string",
alwaysMkdirParents: false,
as2MessageRetentionDays: 0,
askAboutOverwrites: false,
bundleActivityNotifications: "string",
bundleExpiration: 0,
bundleNotFoundMessage: "string",
bundlePasswordRequired: false,
bundleRecipientBlacklistDomains: ["string"],
bundleRecipientBlacklistFreeEmailDomains: false,
bundleRegistrationNotifications: "string",
bundleRequireNote: false,
bundleRequireRegistration: false,
bundleRequireShareRecipient: false,
bundleSendOneTimePasswordToRecipientAtRegistration: false,
bundleSendSharedReceipts: false,
bundleUploadReceiptNotifications: "string",
bundleWatermarkValue: "any",
bundlesDefaultOwnedByPrimaryGroup: false,
calculateFileChecksumsCrc32: false,
calculateFileChecksumsMd5: false,
calculateFileChecksumsSha1: false,
calculateFileChecksumsSha256: false,
color2Left: "string",
color2Link: "string",
color2Text: "string",
color2Top: "string",
color2TopText: "string",
customNamespace: false,
davEnabled: false,
davUserRootEnabled: false,
daysToRetainBackups: 0,
defaultTimeZone: "string",
desktopApp: false,
desktopAppSessionIpPinning: false,
desktopAppSessionLifetime: 0,
disableAllAiFeatures: false,
disableFilesCertificateGeneration: false,
disablePasswordReset: false,
disallowedCountries: "string",
documentEditsInBundleAllowed: false,
domain: "string",
domainHstsHeader: false,
domainLetsencryptChain: "string",
email: "string",
emailFooterCustomText: "string",
fedramp: false,
folderPermissionsGroupsOnly: false,
ftpEnabled: false,
groupAdminsCanAddUsers: false,
groupAdminsCanBypassUserLifecycleRules: false,
groupAdminsCanDeleteUsers: false,
groupAdminsCanEnableDisableUsers: false,
groupAdminsCanManageGroupMemberships: false,
groupAdminsCanModifyUsers: false,
groupAdminsCanResetPasswords: false,
groupAdminsCanSetUserPassword: false,
includePasswordInWelcomeEmail: false,
language: "string",
ldapBaseDn: "string",
ldapDomain: "string",
ldapEnabled: false,
ldapGroupAction: "string",
ldapGroupExclusion: "string",
ldapGroupInclusion: "string",
ldapHost: "string",
ldapHost2: "string",
ldapHost3: "string",
ldapPort: 0,
ldapSecure: false,
ldapType: "string",
ldapUserAction: "string",
ldapUserIncludeGroups: "string",
ldapUsername: "string",
ldapUsernameField: "string",
legacyChecksumsMode: false,
loginHelpText: "string",
maxPriorPasswords: 0,
mcpDcrEnabled: false,
migrateRemoteServerSyncToSync: false,
mobileApp: false,
mobileAppSessionIpPinning: false,
mobileAppSessionLifetime: 0,
motdText: "string",
motdUseForFtp: false,
motdUseForSftp: false,
name: "string",
nonSsoGroupsAllowed: false,
nonSsoUsersAllowed: false,
officeIntegrationAvailable: false,
officeIntegrationType: "string",
optOutGlobal: false,
passwordMinLength: 0,
passwordRequireLetter: false,
passwordRequireMixed: false,
passwordRequireNumber: false,
passwordRequireSpecial: false,
passwordRequireUnbreached: false,
passwordRequirementsApplyToBundles: false,
passwordValidityDays: 0,
pinAllRemoteServersToSiteRegion: false,
preventRootPermissionsForNonSiteAdmins: false,
protocolAccessGroupsOnly: false,
replyToEmail: "string",
require2fa: false,
require2faExemptAllSsoUsers: false,
require2faUserType: "string",
requireLogoutFromBundlesAndInboxes: false,
restrictRootFolderBehaviorsToSiteAdmins: false,
revokeBundleAccessOnDisableOrDelete: false,
rootFolderBehaviorsApplyToWorkspaces: false,
sessionExpiryMinutes: 0,
sftpEnabled: false,
sftpFinalizePartialUploads: false,
sftpHostKeyType: "string",
sftpInsecureCiphers: false,
sftpInsecureDiffieHellman: false,
sftpUserRootEnabled: false,
sharingEnabled: false,
showRequestAccessLink: false,
showUserNotificationsLogInLink: false,
siteFooter: "string",
siteHeader: "string",
sitePublicFooter: "string",
sitePublicHeader: "string",
smtpAddress: "string",
smtpAuthentication: "string",
smtpFrom: "string",
smtpPort: 0,
smtpUsername: "string",
snapshotSharingEnabled: false,
sslRequired: false,
subdomain: "string",
uploadsViaEmailAuthentication: false,
useDedicatedIpsForSmtp: false,
useProvidedModifiedAt: false,
userLockout: false,
userLockoutLockPeriod: 0,
userLockoutTries: 0,
userLockoutWithin: 0,
userRequestsEnabled: false,
userRequestsNotifyAdmins: false,
usernameDisplay: "string",
usersCanCreateApiKeys: false,
usersCanCreateSshKeys: false,
welcomeCustomText: "string",
welcomeEmailCc: "string",
welcomeEmailEnabled: false,
welcomeEmailSubject: "string",
welcomeScreen: "string",
windowsModeFtp: false,
});
type: filescom:Site
properties:
activeSftpHostKeyId: 0
additionalTextFileTypes:
- string
adminsBypassLockedSubfolders: false
aiFeatureAvailability: any
allowBundleNames: false
allowUserLevel2faOverride: false
allowUserLevelAllowedIpOverride: false
allowUserLevelSslOverride: false
allowed2faMethodBypassForFtpSftpDav: false
allowed2faMethodEmail: false
allowed2faMethodSms: false
allowed2faMethodStatic: false
allowed2faMethodTotp: false
allowed2faMethodWebauthn: false
allowed2faMethodYubi: false
allowedCountries: string
allowedIps: string
alwaysMkdirParents: false
as2MessageRetentionDays: 0
askAboutOverwrites: false
bundleActivityNotifications: string
bundleExpiration: 0
bundleNotFoundMessage: string
bundlePasswordRequired: false
bundleRecipientBlacklistDomains:
- string
bundleRecipientBlacklistFreeEmailDomains: false
bundleRegistrationNotifications: string
bundleRequireNote: false
bundleRequireRegistration: false
bundleRequireShareRecipient: false
bundleSendOneTimePasswordToRecipientAtRegistration: false
bundleSendSharedReceipts: false
bundleUploadReceiptNotifications: string
bundleWatermarkValue: any
bundlesDefaultOwnedByPrimaryGroup: false
calculateFileChecksumsCrc32: false
calculateFileChecksumsMd5: false
calculateFileChecksumsSha1: false
calculateFileChecksumsSha256: false
color2Left: string
color2Link: string
color2Text: string
color2Top: string
color2TopText: string
customNamespace: false
davEnabled: false
davUserRootEnabled: false
daysToRetainBackups: 0
defaultTimeZone: string
desktopApp: false
desktopAppSessionIpPinning: false
desktopAppSessionLifetime: 0
disableAllAiFeatures: false
disableFilesCertificateGeneration: false
disablePasswordReset: false
disallowedCountries: string
documentEditsInBundleAllowed: false
domain: string
domainHstsHeader: false
domainLetsencryptChain: string
email: string
emailFooterCustomText: string
fedramp: false
folderPermissionsGroupsOnly: false
ftpEnabled: false
groupAdminsCanAddUsers: false
groupAdminsCanBypassUserLifecycleRules: false
groupAdminsCanDeleteUsers: false
groupAdminsCanEnableDisableUsers: false
groupAdminsCanManageGroupMemberships: false
groupAdminsCanModifyUsers: false
groupAdminsCanResetPasswords: false
groupAdminsCanSetUserPassword: false
includePasswordInWelcomeEmail: false
language: string
ldapBaseDn: string
ldapDomain: string
ldapEnabled: false
ldapGroupAction: string
ldapGroupExclusion: string
ldapGroupInclusion: string
ldapHost: string
ldapHost2: string
ldapHost3: string
ldapPort: 0
ldapSecure: false
ldapType: string
ldapUserAction: string
ldapUserIncludeGroups: string
ldapUsername: string
ldapUsernameField: string
legacyChecksumsMode: false
loginHelpText: string
maxPriorPasswords: 0
mcpDcrEnabled: false
migrateRemoteServerSyncToSync: false
mobileApp: false
mobileAppSessionIpPinning: false
mobileAppSessionLifetime: 0
motdText: string
motdUseForFtp: false
motdUseForSftp: false
name: string
nonSsoGroupsAllowed: false
nonSsoUsersAllowed: false
officeIntegrationAvailable: false
officeIntegrationType: string
optOutGlobal: false
passwordMinLength: 0
passwordRequireLetter: false
passwordRequireMixed: false
passwordRequireNumber: false
passwordRequireSpecial: false
passwordRequireUnbreached: false
passwordRequirementsApplyToBundles: false
passwordValidityDays: 0
pinAllRemoteServersToSiteRegion: false
preventRootPermissionsForNonSiteAdmins: false
protocolAccessGroupsOnly: false
replyToEmail: string
require2fa: false
require2faExemptAllSsoUsers: false
require2faUserType: string
requireLogoutFromBundlesAndInboxes: false
restrictRootFolderBehaviorsToSiteAdmins: false
revokeBundleAccessOnDisableOrDelete: false
rootFolderBehaviorsApplyToWorkspaces: false
sessionExpiryMinutes: 0
sftpEnabled: false
sftpFinalizePartialUploads: false
sftpHostKeyType: string
sftpInsecureCiphers: false
sftpInsecureDiffieHellman: false
sftpUserRootEnabled: false
sharingEnabled: false
showRequestAccessLink: false
showUserNotificationsLogInLink: false
siteFooter: string
siteHeader: string
sitePublicFooter: string
sitePublicHeader: string
smtpAddress: string
smtpAuthentication: string
smtpFrom: string
smtpPort: 0
smtpUsername: string
snapshotSharingEnabled: false
sslRequired: false
subdomain: string
uploadsViaEmailAuthentication: false
useDedicatedIpsForSmtp: false
useProvidedModifiedAt: false
userLockout: false
userLockoutLockPeriod: 0
userLockoutTries: 0
userLockoutWithin: 0
userRequestsEnabled: false
userRequestsNotifyAdmins: false
usernameDisplay: string
usersCanCreateApiKeys: false
usersCanCreateSshKeys: false
welcomeCustomText: string
welcomeEmailCc: string
welcomeEmailEnabled: false
welcomeEmailSubject: string
welcomeScreen: string
windowsModeFtp: false
Site Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Site resource accepts the following input properties:
- Active
Sftp intHost Key Id - Id of the currently selected custom SFTP Host Key
- Additional
Text List<string>File Types - Additional extensions that are considered text files
- Admins
Bypass boolLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- Ai
Feature objectAvailability - Availability settings for AI features by user class
- Allow
Bundle boolNames - Are manual Bundle names allowed?
- Allow
User boolLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- Allow
User boolLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- Allow
User boolLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- Allowed2fa
Method boolBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- Allowed2fa
Method boolEmail - Is OTP via email two factor authentication allowed?
- Allowed2fa
Method boolSms - Is SMS two factor authentication allowed?
- Allowed2fa
Method boolStatic - Is OTP via static codes for two factor authentication allowed?
- Allowed2fa
Method boolTotp - Is TOTP two factor authentication allowed?
- Allowed2fa
Method boolWebauthn - Is WebAuthn two factor authentication allowed?
- Allowed2fa
Method boolYubi - Is yubikey two factor authentication allowed?
- Allowed
Countries string - Comma separated list of allowed Country codes
- Allowed
Ips string - List of allowed IP addresses
- Always
Mkdir boolParents - 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.
- As2Message
Retention intDays - Number of days to retain AS2 messages (incoming and outgoing).
- Ask
About boolOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- Bundle
Activity stringNotifications - Do Bundle owners receive activity notifications?
- Bundle
Expiration int - Site-wide Bundle expiration in days
- Bundle
Not stringFound Message - Custom error message to show when bundle is not found.
- Bundle
Password boolRequired - Do Bundles require password protection?
- Bundle
Recipient List<string>Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- Bundle
Recipient boolBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- Bundle
Registration stringNotifications - Do Bundle owners receive registration notification?
- Bundle
Require boolNote - Do Bundles require internal notes?
- Bundle
Require boolRegistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- Bundle
Send boolOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- Bundle
Upload stringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- Bundle
Watermark objectValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- Bundles
Default boolOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- Calculate
File boolChecksums Crc32 - Calculate CRC32 checksums for files?
- Calculate
File boolChecksums Md5 - Calculate MD5 checksums for files?
- Calculate
File boolChecksums Sha1 - Calculate SHA1 checksums for files?
- Calculate
File boolChecksums Sha256 - Calculate SHA256 checksums for files?
- Color2Left string
- Page link and button color
- Color2Link string
- Top bar link color
- Color2Text string
- Page link and button color
- Color2Top string
- Top bar background color
- Color2Top
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 boolRoot Enabled - Use user FTP roots also for WebDAV?
- Days
To intRetain Backups - Number of days to keep deleted files
- Default
Time stringZone - Site default time zone
- Desktop
App bool - Is the desktop app enabled?
- Desktop
App boolSession Ip Pinning - Is desktop app session IP pinning enabled?
- Desktop
App intSession Lifetime - Desktop app session lifetime (in hours)
- Disable
All boolAi Features - If true, all AI features are disabled for this site.
- Disable
Files boolCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- Disable
Password boolReset - Is password reset disabled?
- Disallowed
Countries string - Comma separated list of disallowed Country codes
- Document
Edits boolIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- Domain string
- Custom domain
- Domain
Hsts boolHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- Domain
Letsencrypt stringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- Email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- Fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- Folder
Permissions boolGroups Only - If true, permissions for this site must be bound to a group (not a user).
- Ftp
Enabled bool - Is FTP enabled?
- Group
Admins boolCan Add Users - Allow group admins to create users in their groups
- Group
Admins boolCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- Group
Admins boolCan Delete Users - Allow group admins to delete users in their groups
- Group
Admins boolCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- Group
Admins boolCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- Group
Admins boolCan Modify Users - Allow group admins to modify users in their groups
- Group
Admins boolCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- Group
Admins boolCan Set User Password - Allow group admins to set password authentication method
- Include
Password boolIn Welcome Email - Include password in emails to new users?
- Language string
- Site default language
- Ldap
Base stringDn - 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 stringAction - Should we sync groups from LDAP server?
- Ldap
Group stringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- Ldap
Group stringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- Ldap
Host string - LDAP host
- Ldap
Host2 string - LDAP backup host
- Ldap
Host3 string - LDAP backup host
- Ldap
Port int - LDAP port
- Ldap
Secure bool - Use secure LDAP?
- Ldap
Type string - LDAP type
- Ldap
User stringAction - Should we sync users from LDAP server?
- Ldap
User stringInclude Groups - 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 stringField - LDAP username field
- Legacy
Checksums boolMode - Use legacy checksums mode?
- Login
Help stringText - Login help text
- Max
Prior intPasswords - Number of prior passwords to disallow
- Mcp
Dcr boolEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- Migrate
Remote boolServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- Mobile
App bool - Is the mobile app enabled?
- Mobile
App boolSession Ip Pinning - Is mobile app session IP pinning enabled?
- Mobile
App intSession Lifetime - Mobile app session lifetime (in hours)
- Motd
Text string - A message to show users when they connect via FTP or SFTP.
- Motd
Use boolFor Ftp - Show message to users connecting via FTP
- Motd
Use boolFor Sftp - Show message to users connecting via SFTP
- Name string
- Site name
- Non
Sso boolGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- Non
Sso boolUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- bool
- If true, allows users to use a document editing integration.
- Office
Integration stringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- Opt
Out boolGlobal - Use servers in the USA only?
- Password
Min intLength - Shortest password length for users
- Password
Require boolLetter - Require a letter in passwords?
- Password
Require boolMixed - Require lower and upper case letters in passwords?
- Password
Require boolNumber - Require a number in passwords?
- Password
Require boolSpecial - Require special characters in password?
- Password
Require boolUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- Password
Requirements boolApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- Password
Validity intDays - Number of days password is valid
- Pin
All boolRemote Servers To Site Region - 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 boolPermissions For Non Site Admins - 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 boolGroups Only - 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.
- Reply
To stringEmail - Reply-to email for this site
- Require2fa bool
- Require two-factor authentication for all users?
- Require2fa
Exempt boolAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- Require2fa
User stringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - Require
Logout boolFrom Bundles And Inboxes - 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.
- Restrict
Root boolFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- Revoke
Bundle boolAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- Root
Folder boolBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- Session
Expiry intMinutes - Session expiry in minutes
- Sftp
Enabled bool - Is SFTP enabled?
- Sftp
Finalize boolPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- Sftp
Host stringKey Type - Sftp Host Key Type
- Sftp
Insecure boolCiphers - 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 boolDiffie Hellman - 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
sftpInsecureCiphersoption. - Sftp
User boolRoot Enabled - Use user FTP roots also for SFTP?
- bool
- Allow bundle creation
- Show
Request boolAccess Link - Show request access link for users without access? Currently unused.
- Show
User boolNotifications Log In Link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- Site
Header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- Site
Public stringHeader - 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 int - SMTP server port
- Smtp
Username string - SMTP server username
- Snapshot
Sharing boolEnabled - Allow snapshot share links creation
- Ssl
Required bool - Is SSL required? Disabling this is insecure.
- Subdomain string
- Site subdomain
- Uploads
Via boolEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- Use
Dedicated boolIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- Use
Provided boolModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - User
Lockout bool - Will users be locked out after incorrect login attempts?
- User
Lockout intLock Period - How many hours to lock user out for failed password?
- User
Lockout intTries - Number of login tries within
userLockoutWithinhours before users are locked out - User
Lockout intWithin - Number of hours for user lockout window
- User
Requests boolEnabled - Enable User Requests feature
- User
Requests boolNotify Admins - Send email to site admins when a user request is received?
- Username
Display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - Users
Can boolCreate Api Keys - Allow users to create their own API keys?
- Users
Can boolCreate Ssh Keys - Allow users to create their own SSH keys?
- Welcome
Custom stringText - Custom text send in user welcome email
- Welcome
Email stringCc - Include this email in welcome emails if enabled
- Welcome
Email boolEnabled - Will the welcome email be sent to new users?
- Welcome
Email stringSubject - Include this email subject in welcome emails if enabled
- Welcome
Screen string - Does the welcome screen appear?
- Windows
Mode boolFtp - Does FTP user Windows emulation mode?
- Active
Sftp intHost Key Id - Id of the currently selected custom SFTP Host Key
- Additional
Text []stringFile Types - Additional extensions that are considered text files
- Admins
Bypass boolLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- Ai
Feature interface{}Availability - Availability settings for AI features by user class
- Allow
Bundle boolNames - Are manual Bundle names allowed?
- Allow
User boolLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- Allow
User boolLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- Allow
User boolLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- Allowed2fa
Method boolBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- Allowed2fa
Method boolEmail - Is OTP via email two factor authentication allowed?
- Allowed2fa
Method boolSms - Is SMS two factor authentication allowed?
- Allowed2fa
Method boolStatic - Is OTP via static codes for two factor authentication allowed?
- Allowed2fa
Method boolTotp - Is TOTP two factor authentication allowed?
- Allowed2fa
Method boolWebauthn - Is WebAuthn two factor authentication allowed?
- Allowed2fa
Method boolYubi - Is yubikey two factor authentication allowed?
- Allowed
Countries string - Comma separated list of allowed Country codes
- Allowed
Ips string - List of allowed IP addresses
- Always
Mkdir boolParents - 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.
- As2Message
Retention intDays - Number of days to retain AS2 messages (incoming and outgoing).
- Ask
About boolOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- Bundle
Activity stringNotifications - Do Bundle owners receive activity notifications?
- Bundle
Expiration int - Site-wide Bundle expiration in days
- Bundle
Not stringFound Message - Custom error message to show when bundle is not found.
- Bundle
Password boolRequired - Do Bundles require password protection?
- Bundle
Recipient []stringBlacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- Bundle
Recipient boolBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- Bundle
Registration stringNotifications - Do Bundle owners receive registration notification?
- Bundle
Require boolNote - Do Bundles require internal notes?
- Bundle
Require boolRegistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- Bundle
Send boolOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- Bundle
Upload stringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- Bundle
Watermark interface{}Value - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- Bundles
Default boolOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- Calculate
File boolChecksums Crc32 - Calculate CRC32 checksums for files?
- Calculate
File boolChecksums Md5 - Calculate MD5 checksums for files?
- Calculate
File boolChecksums Sha1 - Calculate SHA1 checksums for files?
- Calculate
File boolChecksums Sha256 - Calculate SHA256 checksums for files?
- Color2Left string
- Page link and button color
- Color2Link string
- Top bar link color
- Color2Text string
- Page link and button color
- Color2Top string
- Top bar background color
- Color2Top
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 boolRoot Enabled - Use user FTP roots also for WebDAV?
- Days
To intRetain Backups - Number of days to keep deleted files
- Default
Time stringZone - Site default time zone
- Desktop
App bool - Is the desktop app enabled?
- Desktop
App boolSession Ip Pinning - Is desktop app session IP pinning enabled?
- Desktop
App intSession Lifetime - Desktop app session lifetime (in hours)
- Disable
All boolAi Features - If true, all AI features are disabled for this site.
- Disable
Files boolCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- Disable
Password boolReset - Is password reset disabled?
- Disallowed
Countries string - Comma separated list of disallowed Country codes
- Document
Edits boolIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- Domain string
- Custom domain
- Domain
Hsts boolHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- Domain
Letsencrypt stringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- Email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- Fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- Folder
Permissions boolGroups Only - If true, permissions for this site must be bound to a group (not a user).
- Ftp
Enabled bool - Is FTP enabled?
- Group
Admins boolCan Add Users - Allow group admins to create users in their groups
- Group
Admins boolCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- Group
Admins boolCan Delete Users - Allow group admins to delete users in their groups
- Group
Admins boolCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- Group
Admins boolCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- Group
Admins boolCan Modify Users - Allow group admins to modify users in their groups
- Group
Admins boolCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- Group
Admins boolCan Set User Password - Allow group admins to set password authentication method
- Include
Password boolIn Welcome Email - Include password in emails to new users?
- Language string
- Site default language
- Ldap
Base stringDn - 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 stringAction - Should we sync groups from LDAP server?
- Ldap
Group stringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- Ldap
Group stringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- Ldap
Host string - LDAP host
- Ldap
Host2 string - LDAP backup host
- Ldap
Host3 string - LDAP backup host
- Ldap
Port int - LDAP port
- Ldap
Secure bool - Use secure LDAP?
- Ldap
Type string - LDAP type
- Ldap
User stringAction - Should we sync users from LDAP server?
- Ldap
User stringInclude Groups - 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 stringField - LDAP username field
- Legacy
Checksums boolMode - Use legacy checksums mode?
- Login
Help stringText - Login help text
- Max
Prior intPasswords - Number of prior passwords to disallow
- Mcp
Dcr boolEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- Migrate
Remote boolServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- Mobile
App bool - Is the mobile app enabled?
- Mobile
App boolSession Ip Pinning - Is mobile app session IP pinning enabled?
- Mobile
App intSession Lifetime - Mobile app session lifetime (in hours)
- Motd
Text string - A message to show users when they connect via FTP or SFTP.
- Motd
Use boolFor Ftp - Show message to users connecting via FTP
- Motd
Use boolFor Sftp - Show message to users connecting via SFTP
- Name string
- Site name
- Non
Sso boolGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- Non
Sso boolUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- bool
- If true, allows users to use a document editing integration.
- Office
Integration stringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- Opt
Out boolGlobal - Use servers in the USA only?
- Password
Min intLength - Shortest password length for users
- Password
Require boolLetter - Require a letter in passwords?
- Password
Require boolMixed - Require lower and upper case letters in passwords?
- Password
Require boolNumber - Require a number in passwords?
- Password
Require boolSpecial - Require special characters in password?
- Password
Require boolUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- Password
Requirements boolApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- Password
Validity intDays - Number of days password is valid
- Pin
All boolRemote Servers To Site Region - 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 boolPermissions For Non Site Admins - 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 boolGroups Only - 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.
- Reply
To stringEmail - Reply-to email for this site
- Require2fa bool
- Require two-factor authentication for all users?
- Require2fa
Exempt boolAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- Require2fa
User stringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - Require
Logout boolFrom Bundles And Inboxes - 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.
- Restrict
Root boolFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- Revoke
Bundle boolAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- Root
Folder boolBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- Session
Expiry intMinutes - Session expiry in minutes
- Sftp
Enabled bool - Is SFTP enabled?
- Sftp
Finalize boolPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- Sftp
Host stringKey Type - Sftp Host Key Type
- Sftp
Insecure boolCiphers - 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 boolDiffie Hellman - 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
sftpInsecureCiphersoption. - Sftp
User boolRoot Enabled - Use user FTP roots also for SFTP?
- bool
- Allow bundle creation
- Show
Request boolAccess Link - Show request access link for users without access? Currently unused.
- Show
User boolNotifications Log In Link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- Site
Header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- Site
Public stringHeader - 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 int - SMTP server port
- Smtp
Username string - SMTP server username
- Snapshot
Sharing boolEnabled - Allow snapshot share links creation
- Ssl
Required bool - Is SSL required? Disabling this is insecure.
- Subdomain string
- Site subdomain
- Uploads
Via boolEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- Use
Dedicated boolIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- Use
Provided boolModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - User
Lockout bool - Will users be locked out after incorrect login attempts?
- User
Lockout intLock Period - How many hours to lock user out for failed password?
- User
Lockout intTries - Number of login tries within
userLockoutWithinhours before users are locked out - User
Lockout intWithin - Number of hours for user lockout window
- User
Requests boolEnabled - Enable User Requests feature
- User
Requests boolNotify Admins - Send email to site admins when a user request is received?
- Username
Display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - Users
Can boolCreate Api Keys - Allow users to create their own API keys?
- Users
Can boolCreate Ssh Keys - Allow users to create their own SSH keys?
- Welcome
Custom stringText - Custom text send in user welcome email
- Welcome
Email stringCc - Include this email in welcome emails if enabled
- Welcome
Email boolEnabled - Will the welcome email be sent to new users?
- Welcome
Email stringSubject - Include this email subject in welcome emails if enabled
- Welcome
Screen string - Does the welcome screen appear?
- Windows
Mode boolFtp - Does FTP user Windows emulation mode?
- active_
sftp_ numberhost_ key_ id - Id of the currently selected custom SFTP Host Key
- additional_
text_ list(string)file_ types - Additional extensions that are considered text files
- admins_
bypass_ boollocked_ subfolders - Allow admins to bypass the locked subfolders setting.
- ai_
feature_ anyavailability - Availability settings for AI features by user class
- allow_
bundle_ boolnames - Are manual Bundle names allowed?
- allow_
user_ boollevel2fa_ override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow_
user_ boollevel_ allowed_ ip_ override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow_
user_ boollevel_ ssl_ override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa_
method_ boolbypass_ for_ ftp_ sftp_ dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa_
method_ boolemail - Is OTP via email two factor authentication allowed?
- allowed2fa_
method_ boolsms - Is SMS two factor authentication allowed?
- allowed2fa_
method_ boolstatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa_
method_ booltotp - Is TOTP two factor authentication allowed?
- allowed2fa_
method_ boolwebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa_
method_ boolyubi - Is yubikey two factor authentication allowed?
- allowed_
countries string - Comma separated list of allowed Country codes
- allowed_
ips string - List of allowed IP addresses
- always_
mkdir_ boolparents - 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_ numberretention_ days - Number of days to retain AS2 messages (incoming and outgoing).
- ask_
about_ booloverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle_
activity_ stringnotifications - Do Bundle owners receive activity notifications?
- bundle_
expiration number - Site-wide Bundle expiration in days
- bundle_
not_ stringfound_ message - Custom error message to show when bundle is not found.
- bundle_
password_ boolrequired - Do Bundles require password protection?
- bundle_
recipient_ list(string)blacklist_ domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle_
recipient_ boolblacklist_ free_ email_ domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle_
registration_ stringnotifications - Do Bundle owners receive registration notification?
- bundle_
require_ boolnote - Do Bundles require internal notes?
- bundle_
require_ boolregistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- bundle_
send_ boolone_ time_ password_ to_ recipient_ at_ registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- bundle_
upload_ stringreceipt_ notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle_
watermark_ anyvalue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles_
default_ boolowned_ by_ primary_ group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate_
file_ boolchecksums_ crc32 - Calculate CRC32 checksums for files?
- calculate_
file_ boolchecksums_ md5 - Calculate MD5 checksums for files?
- calculate_
file_ boolchecksums_ sha1 - Calculate SHA1 checksums for files?
- calculate_
file_ boolchecksums_ sha256 - Calculate SHA256 checksums for files?
- 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_ stringtext - Top bar text color
- custom_
namespace bool - Is this site using a custom namespace for users?
- dav_
enabled bool - Is WebDAV enabled?
- dav_
user_ boolroot_ enabled - Use user FTP roots also for WebDAV?
- days_
to_ numberretain_ backups - Number of days to keep deleted files
- default_
time_ stringzone - Site default time zone
- desktop_
app bool - Is the desktop app enabled?
- desktop_
app_ boolsession_ ip_ pinning - Is desktop app session IP pinning enabled?
- desktop_
app_ numbersession_ lifetime - Desktop app session lifetime (in hours)
- disable_
all_ boolai_ features - If true, all AI features are disabled for this site.
- disable_
files_ boolcertificate_ generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable_
password_ boolreset - Is password reset disabled?
- disallowed_
countries string - Comma separated list of disallowed Country codes
- document_
edits_ boolin_ bundle_ allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain string
- Custom domain
- domain_
hsts_ boolheader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain_
letsencrypt_ stringchain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- folder_
permissions_ boolgroups_ only - If true, permissions for this site must be bound to a group (not a user).
- ftp_
enabled bool - Is FTP enabled?
- group_
admins_ boolcan_ add_ users - Allow group admins to create users in their groups
- group_
admins_ boolcan_ bypass_ user_ lifecycle_ rules - Allow group admins to exempt users in their groups from lifecycle rules
- group_
admins_ boolcan_ delete_ users - Allow group admins to delete users in their groups
- group_
admins_ boolcan_ enable_ disable_ users - Allow group admins to enable or disable users in their groups
- group_
admins_ boolcan_ manage_ group_ memberships - Allow group admins to add or remove existing users in their groups
- group_
admins_ boolcan_ modify_ users - Allow group admins to modify users in their groups
- group_
admins_ boolcan_ reset_ passwords - Allow group admins to reset passwords for users in their groups
- group_
admins_ boolcan_ set_ user_ password - Allow group admins to set password authentication method
- include_
password_ boolin_ welcome_ email - Include password in emails to new users?
- language string
- Site default language
- ldap_
base_ stringdn - 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_ stringaction - Should we sync groups from LDAP server?
- ldap_
group_ stringexclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap_
group_ stringinclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap_
host string - LDAP host
- ldap_
host2 string - LDAP backup host
- ldap_
host3 string - LDAP backup host
- ldap_
port number - LDAP port
- ldap_
secure bool - Use secure LDAP?
- ldap_
type string - LDAP type
- ldap_
user_ stringaction - Should we sync users from LDAP server?
- ldap_
user_ stringinclude_ groups - 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_ stringfield - LDAP username field
- legacy_
checksums_ boolmode - Use legacy checksums mode?
- login_
help_ stringtext - Login help text
- max_
prior_ numberpasswords - Number of prior passwords to disallow
- mcp_
dcr_ boolenabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate_
remote_ boolserver_ sync_ to_ sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile_
app bool - Is the mobile app enabled?
- mobile_
app_ boolsession_ ip_ pinning - Is mobile app session IP pinning enabled?
- mobile_
app_ numbersession_ lifetime - Mobile app session lifetime (in hours)
- motd_
text string - A message to show users when they connect via FTP or SFTP.
- motd_
use_ boolfor_ ftp - Show message to users connecting via FTP
- motd_
use_ boolfor_ sftp - Show message to users connecting via SFTP
- name string
- Site name
- non_
sso_ boolgroups_ allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non_
sso_ boolusers_ allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- office_
integration_ boolavailable - If true, allows users to use a document editing integration.
- office_
integration_ stringtype - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- opt_
out_ boolglobal - Use servers in the USA only?
- password_
min_ numberlength - Shortest password length for users
- password_
require_ boolletter - Require a letter in passwords?
- password_
require_ boolmixed - Require lower and upper case letters in passwords?
- password_
require_ boolnumber - Require a number in passwords?
- password_
require_ boolspecial - Require special characters in password?
- password_
require_ boolunbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password_
requirements_ boolapply_ to_ bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password_
validity_ numberdays - Number of days password is valid
- pin_
all_ boolremote_ servers_ to_ site_ region - 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_ boolpermissions_ for_ non_ site_ admins - 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_ boolgroups_ only - 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.
- reply_
to_ stringemail - Reply-to email for this site
- require2fa bool
- Require two-factor authentication for all users?
- require2fa_
exempt_ boolall_ sso_ users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa_
user_ stringtype - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require_
logout_ boolfrom_ bundles_ and_ inboxes - 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.
- restrict_
root_ boolfolder_ behaviors_ to_ site_ admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke_
bundle_ boolaccess_ on_ disable_ or_ delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root_
folder_ boolbehaviors_ apply_ to_ workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session_
expiry_ numberminutes - Session expiry in minutes
- sftp_
enabled bool - Is SFTP enabled?
- sftp_
finalize_ boolpartial_ uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp_
host_ stringkey_ type - Sftp Host Key Type
- sftp_
insecure_ boolciphers - 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_ booldiffie_ hellman - 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
sftpInsecureCiphersoption. - sftp_
user_ boolroot_ enabled - Use user FTP roots also for SFTP?
- bool
- Allow bundle creation
- show_
request_ boolaccess_ link - Show request access link for users without access? Currently unused.
- show_
user_ boolnotifications_ log_ in_ link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- site_
header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- site_
public_ stringheader - 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 number - SMTP server port
- smtp_
username string - SMTP server username
- snapshot_
sharing_ boolenabled - Allow snapshot share links creation
- ssl_
required bool - Is SSL required? Disabling this is insecure.
- subdomain string
- Site subdomain
- uploads_
via_ boolemail_ authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use_
dedicated_ boolips_ for_ smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use_
provided_ boolmodified_ at - Allow uploaders to set
providedModifiedAtfor uploaded files? - user_
lockout bool - Will users be locked out after incorrect login attempts?
- user_
lockout_ numberlock_ period - How many hours to lock user out for failed password?
- user_
lockout_ numbertries - Number of login tries within
userLockoutWithinhours before users are locked out - user_
lockout_ numberwithin - Number of hours for user lockout window
- user_
requests_ boolenabled - Enable User Requests feature
- user_
requests_ boolnotify_ admins - Send email to site admins when a user request is received?
- username_
display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users_
can_ boolcreate_ api_ keys - Allow users to create their own API keys?
- users_
can_ boolcreate_ ssh_ keys - Allow users to create their own SSH keys?
- welcome_
custom_ stringtext - Custom text send in user welcome email
- welcome_
email_ stringcc - Include this email in welcome emails if enabled
- welcome_
email_ boolenabled - Will the welcome email be sent to new users?
- welcome_
email_ stringsubject - Include this email subject in welcome emails if enabled
- welcome_
screen string - Does the welcome screen appear?
- windows_
mode_ boolftp - Does FTP user Windows emulation mode?
- active
Sftp IntegerHost Key Id - Id of the currently selected custom SFTP Host Key
- additional
Text List<String>File Types - Additional extensions that are considered text files
- admins
Bypass BooleanLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- ai
Feature ObjectAvailability - Availability settings for AI features by user class
- allow
Bundle BooleanNames - Are manual Bundle names allowed?
- allow
User BooleanLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow
User BooleanLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow
User BooleanLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa
Method BooleanBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa
Method BooleanEmail - Is OTP via email two factor authentication allowed?
- allowed2fa
Method BooleanSms - Is SMS two factor authentication allowed?
- allowed2fa
Method BooleanStatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa
Method BooleanTotp - Is TOTP two factor authentication allowed?
- allowed2fa
Method BooleanWebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa
Method BooleanYubi - Is yubikey two factor authentication allowed?
- allowed
Countries String - Comma separated list of allowed Country codes
- allowed
Ips String - List of allowed IP addresses
- always
Mkdir BooleanParents - 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.
- as2Message
Retention IntegerDays - Number of days to retain AS2 messages (incoming and outgoing).
- ask
About BooleanOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle
Activity StringNotifications - Do Bundle owners receive activity notifications?
- bundle
Expiration Integer - Site-wide Bundle expiration in days
- bundle
Not StringFound Message - Custom error message to show when bundle is not found.
- bundle
Password BooleanRequired - Do Bundles require password protection?
- bundle
Recipient List<String>Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle
Recipient BooleanBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle
Registration StringNotifications - Do Bundle owners receive registration notification?
- bundle
Require BooleanNote - Do Bundles require internal notes?
- bundle
Require BooleanRegistration - Do Bundles require registration?
- Boolean
- Do Bundles require recipients for sharing?
- bundle
Send BooleanOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- Boolean
- Do Bundle creators receive receipts of invitations?
- bundle
Upload StringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle
Watermark ObjectValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles
Default BooleanOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate
File BooleanChecksums Crc32 - Calculate CRC32 checksums for files?
- calculate
File BooleanChecksums Md5 - Calculate MD5 checksums for files?
- calculate
File BooleanChecksums Sha1 - Calculate SHA1 checksums for files?
- calculate
File BooleanChecksums Sha256 - Calculate SHA256 checksums for files?
- color2Left String
- Page link and button color
- color2Link String
- Top bar link color
- color2Text String
- Page link and button color
- color2Top String
- Top bar background color
- color2Top
Text String - Top bar text color
- custom
Namespace Boolean - Is this site using a custom namespace for users?
- dav
Enabled Boolean - Is WebDAV enabled?
- dav
User BooleanRoot Enabled - Use user FTP roots also for WebDAV?
- days
To IntegerRetain Backups - Number of days to keep deleted files
- default
Time StringZone - Site default time zone
- desktop
App Boolean - Is the desktop app enabled?
- desktop
App BooleanSession Ip Pinning - Is desktop app session IP pinning enabled?
- desktop
App IntegerSession Lifetime - Desktop app session lifetime (in hours)
- disable
All BooleanAi Features - If true, all AI features are disabled for this site.
- disable
Files BooleanCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable
Password BooleanReset - Is password reset disabled?
- disallowed
Countries String - Comma separated list of disallowed Country codes
- document
Edits BooleanIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain String
- Custom domain
- domain
Hsts BooleanHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain
Letsencrypt StringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email String
- Main email for this site
- String
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp Boolean
- Are FedRAMP security restrictions enabled for this site?
- folder
Permissions BooleanGroups Only - If true, permissions for this site must be bound to a group (not a user).
- ftp
Enabled Boolean - Is FTP enabled?
- group
Admins BooleanCan Add Users - Allow group admins to create users in their groups
- group
Admins BooleanCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- group
Admins BooleanCan Delete Users - Allow group admins to delete users in their groups
- group
Admins BooleanCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- group
Admins BooleanCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- group
Admins BooleanCan Modify Users - Allow group admins to modify users in their groups
- group
Admins BooleanCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- group
Admins BooleanCan Set User Password - Allow group admins to set password authentication method
- include
Password BooleanIn Welcome Email - Include password in emails to new users?
- language String
- Site default language
- ldap
Base StringDn - Base DN for looking up users in LDAP server
- ldap
Domain String - Domain name that will be appended to usernames
- ldap
Enabled Boolean - Main LDAP setting: is LDAP enabled?
- ldap
Group StringAction - Should we sync groups from LDAP server?
- ldap
Group StringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap
Group StringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap
Host String - LDAP host
- ldap
Host2 String - LDAP backup host
- ldap
Host3 String - LDAP backup host
- ldap
Port Integer - LDAP port
- ldap
Secure Boolean - Use secure LDAP?
- ldap
Type String - LDAP type
- ldap
User StringAction - Should we sync users from LDAP server?
- ldap
User StringInclude Groups - 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 StringField - LDAP username field
- legacy
Checksums BooleanMode - Use legacy checksums mode?
- login
Help StringText - Login help text
- max
Prior IntegerPasswords - Number of prior passwords to disallow
- mcp
Dcr BooleanEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate
Remote BooleanServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile
App Boolean - Is the mobile app enabled?
- mobile
App BooleanSession Ip Pinning - Is mobile app session IP pinning enabled?
- mobile
App IntegerSession Lifetime - Mobile app session lifetime (in hours)
- motd
Text String - A message to show users when they connect via FTP or SFTP.
- motd
Use BooleanFor Ftp - Show message to users connecting via FTP
- motd
Use BooleanFor Sftp - Show message to users connecting via SFTP
- name String
- Site name
- non
Sso BooleanGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non
Sso BooleanUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- Boolean
- If true, allows users to use a document editing integration.
- office
Integration StringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- opt
Out BooleanGlobal - Use servers in the USA only?
- password
Min IntegerLength - Shortest password length for users
- password
Require BooleanLetter - Require a letter in passwords?
- password
Require BooleanMixed - Require lower and upper case letters in passwords?
- password
Require BooleanNumber - Require a number in passwords?
- password
Require BooleanSpecial - Require special characters in password?
- password
Require BooleanUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password
Requirements BooleanApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password
Validity IntegerDays - Number of days password is valid
- pin
All BooleanRemote Servers To Site Region - 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 BooleanPermissions For Non Site Admins - 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 BooleanGroups Only - 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.
- reply
To StringEmail - Reply-to email for this site
- require2fa Boolean
- Require two-factor authentication for all users?
- require2fa
Exempt BooleanAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa
User StringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require
Logout BooleanFrom Bundles And Inboxes - 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.
- restrict
Root BooleanFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke
Bundle BooleanAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root
Folder BooleanBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session
Expiry IntegerMinutes - Session expiry in minutes
- sftp
Enabled Boolean - Is SFTP enabled?
- sftp
Finalize BooleanPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp
Host StringKey Type - Sftp Host Key Type
- sftp
Insecure BooleanCiphers - 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 BooleanDiffie Hellman - 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
sftpInsecureCiphersoption. - sftp
User BooleanRoot Enabled - Use user FTP roots also for SFTP?
- Boolean
- Allow bundle creation
- show
Request BooleanAccess Link - Show request access link for users without access? Currently unused.
- show
User BooleanNotifications Log In Link - Show log in link in user notifications?
- String
- Custom site footer text for authenticated pages
- site
Header String - Custom site header text for authenticated pages
- String
- Custom site footer text for public pages
- site
Public StringHeader - 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 Integer - SMTP server port
- smtp
Username String - SMTP server username
- snapshot
Sharing BooleanEnabled - Allow snapshot share links creation
- ssl
Required Boolean - Is SSL required? Disabling this is insecure.
- subdomain String
- Site subdomain
- uploads
Via BooleanEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use
Dedicated BooleanIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use
Provided BooleanModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - user
Lockout Boolean - Will users be locked out after incorrect login attempts?
- user
Lockout IntegerLock Period - How many hours to lock user out for failed password?
- user
Lockout IntegerTries - Number of login tries within
userLockoutWithinhours before users are locked out - user
Lockout IntegerWithin - Number of hours for user lockout window
- user
Requests BooleanEnabled - Enable User Requests feature
- user
Requests BooleanNotify Admins - Send email to site admins when a user request is received?
- username
Display String - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users
Can BooleanCreate Api Keys - Allow users to create their own API keys?
- users
Can BooleanCreate Ssh Keys - Allow users to create their own SSH keys?
- welcome
Custom StringText - Custom text send in user welcome email
- welcome
Email StringCc - Include this email in welcome emails if enabled
- welcome
Email BooleanEnabled - Will the welcome email be sent to new users?
- welcome
Email StringSubject - Include this email subject in welcome emails if enabled
- welcome
Screen String - Does the welcome screen appear?
- windows
Mode BooleanFtp - Does FTP user Windows emulation mode?
- active
Sftp numberHost Key Id - Id of the currently selected custom SFTP Host Key
- additional
Text string[]File Types - Additional extensions that are considered text files
- admins
Bypass booleanLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- ai
Feature anyAvailability - Availability settings for AI features by user class
- allow
Bundle booleanNames - Are manual Bundle names allowed?
- allow
User booleanLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow
User booleanLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow
User booleanLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa
Method booleanBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa
Method booleanEmail - Is OTP via email two factor authentication allowed?
- allowed2fa
Method booleanSms - Is SMS two factor authentication allowed?
- allowed2fa
Method booleanStatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa
Method booleanTotp - Is TOTP two factor authentication allowed?
- allowed2fa
Method booleanWebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa
Method booleanYubi - Is yubikey two factor authentication allowed?
- allowed
Countries string - Comma separated list of allowed Country codes
- allowed
Ips string - List of allowed IP addresses
- always
Mkdir booleanParents - 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.
- as2Message
Retention numberDays - Number of days to retain AS2 messages (incoming and outgoing).
- ask
About booleanOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle
Activity stringNotifications - Do Bundle owners receive activity notifications?
- bundle
Expiration number - Site-wide Bundle expiration in days
- bundle
Not stringFound Message - Custom error message to show when bundle is not found.
- bundle
Password booleanRequired - Do Bundles require password protection?
- bundle
Recipient string[]Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle
Recipient booleanBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle
Registration stringNotifications - Do Bundle owners receive registration notification?
- bundle
Require booleanNote - Do Bundles require internal notes?
- bundle
Require booleanRegistration - Do Bundles require registration?
- boolean
- Do Bundles require recipients for sharing?
- bundle
Send booleanOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- boolean
- Do Bundle creators receive receipts of invitations?
- bundle
Upload stringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle
Watermark anyValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles
Default booleanOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate
File booleanChecksums Crc32 - Calculate CRC32 checksums for files?
- calculate
File booleanChecksums Md5 - Calculate MD5 checksums for files?
- calculate
File booleanChecksums Sha1 - Calculate SHA1 checksums for files?
- calculate
File booleanChecksums Sha256 - Calculate SHA256 checksums for files?
- color2Left string
- Page link and button color
- color2Link string
- Top bar link color
- color2Text string
- Page link and button color
- color2Top string
- Top bar background color
- color2Top
Text string - Top bar text color
- custom
Namespace boolean - Is this site using a custom namespace for users?
- dav
Enabled boolean - Is WebDAV enabled?
- dav
User booleanRoot Enabled - Use user FTP roots also for WebDAV?
- days
To numberRetain Backups - Number of days to keep deleted files
- default
Time stringZone - Site default time zone
- desktop
App boolean - Is the desktop app enabled?
- desktop
App booleanSession Ip Pinning - Is desktop app session IP pinning enabled?
- desktop
App numberSession Lifetime - Desktop app session lifetime (in hours)
- disable
All booleanAi Features - If true, all AI features are disabled for this site.
- disable
Files booleanCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable
Password booleanReset - Is password reset disabled?
- disallowed
Countries string - Comma separated list of disallowed Country codes
- document
Edits booleanIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain string
- Custom domain
- domain
Hsts booleanHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain
Letsencrypt stringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp boolean
- Are FedRAMP security restrictions enabled for this site?
- folder
Permissions booleanGroups Only - If true, permissions for this site must be bound to a group (not a user).
- ftp
Enabled boolean - Is FTP enabled?
- group
Admins booleanCan Add Users - Allow group admins to create users in their groups
- group
Admins booleanCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- group
Admins booleanCan Delete Users - Allow group admins to delete users in their groups
- group
Admins booleanCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- group
Admins booleanCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- group
Admins booleanCan Modify Users - Allow group admins to modify users in their groups
- group
Admins booleanCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- group
Admins booleanCan Set User Password - Allow group admins to set password authentication method
- include
Password booleanIn Welcome Email - Include password in emails to new users?
- language string
- Site default language
- ldap
Base stringDn - Base DN for looking up users in LDAP server
- ldap
Domain string - Domain name that will be appended to usernames
- ldap
Enabled boolean - Main LDAP setting: is LDAP enabled?
- ldap
Group stringAction - Should we sync groups from LDAP server?
- ldap
Group stringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap
Group stringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap
Host string - LDAP host
- ldap
Host2 string - LDAP backup host
- ldap
Host3 string - LDAP backup host
- ldap
Port number - LDAP port
- ldap
Secure boolean - Use secure LDAP?
- ldap
Type string - LDAP type
- ldap
User stringAction - Should we sync users from LDAP server?
- ldap
User stringInclude Groups - 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 stringField - LDAP username field
- legacy
Checksums booleanMode - Use legacy checksums mode?
- login
Help stringText - Login help text
- max
Prior numberPasswords - Number of prior passwords to disallow
- mcp
Dcr booleanEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate
Remote booleanServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile
App boolean - Is the mobile app enabled?
- mobile
App booleanSession Ip Pinning - Is mobile app session IP pinning enabled?
- mobile
App numberSession Lifetime - Mobile app session lifetime (in hours)
- motd
Text string - A message to show users when they connect via FTP or SFTP.
- motd
Use booleanFor Ftp - Show message to users connecting via FTP
- motd
Use booleanFor Sftp - Show message to users connecting via SFTP
- name string
- Site name
- non
Sso booleanGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non
Sso booleanUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- boolean
- If true, allows users to use a document editing integration.
- office
Integration stringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- opt
Out booleanGlobal - Use servers in the USA only?
- password
Min numberLength - Shortest password length for users
- password
Require booleanLetter - Require a letter in passwords?
- password
Require booleanMixed - Require lower and upper case letters in passwords?
- password
Require booleanNumber - Require a number in passwords?
- password
Require booleanSpecial - Require special characters in password?
- password
Require booleanUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password
Requirements booleanApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password
Validity numberDays - Number of days password is valid
- pin
All booleanRemote Servers To Site Region - 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 booleanPermissions For Non Site Admins - 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 booleanGroups Only - 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.
- reply
To stringEmail - Reply-to email for this site
- require2fa boolean
- Require two-factor authentication for all users?
- require2fa
Exempt booleanAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa
User stringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require
Logout booleanFrom Bundles And Inboxes - 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.
- restrict
Root booleanFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke
Bundle booleanAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root
Folder booleanBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session
Expiry numberMinutes - Session expiry in minutes
- sftp
Enabled boolean - Is SFTP enabled?
- sftp
Finalize booleanPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp
Host stringKey Type - Sftp Host Key Type
- sftp
Insecure booleanCiphers - 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 booleanDiffie Hellman - 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
sftpInsecureCiphersoption. - sftp
User booleanRoot Enabled - Use user FTP roots also for SFTP?
- boolean
- Allow bundle creation
- show
Request booleanAccess Link - Show request access link for users without access? Currently unused.
- show
User booleanNotifications Log In Link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- site
Header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- site
Public stringHeader - 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 number - SMTP server port
- smtp
Username string - SMTP server username
- snapshot
Sharing booleanEnabled - Allow snapshot share links creation
- ssl
Required boolean - Is SSL required? Disabling this is insecure.
- subdomain string
- Site subdomain
- uploads
Via booleanEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use
Dedicated booleanIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use
Provided booleanModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - user
Lockout boolean - Will users be locked out after incorrect login attempts?
- user
Lockout numberLock Period - How many hours to lock user out for failed password?
- user
Lockout numberTries - Number of login tries within
userLockoutWithinhours before users are locked out - user
Lockout numberWithin - Number of hours for user lockout window
- user
Requests booleanEnabled - Enable User Requests feature
- user
Requests booleanNotify Admins - Send email to site admins when a user request is received?
- username
Display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users
Can booleanCreate Api Keys - Allow users to create their own API keys?
- users
Can booleanCreate Ssh Keys - Allow users to create their own SSH keys?
- welcome
Custom stringText - Custom text send in user welcome email
- welcome
Email stringCc - Include this email in welcome emails if enabled
- welcome
Email booleanEnabled - Will the welcome email be sent to new users?
- welcome
Email stringSubject - Include this email subject in welcome emails if enabled
- welcome
Screen string - Does the welcome screen appear?
- windows
Mode booleanFtp - Does FTP user Windows emulation mode?
- active_
sftp_ inthost_ key_ id - Id of the currently selected custom SFTP Host Key
- additional_
text_ Sequence[str]file_ types - Additional extensions that are considered text files
- admins_
bypass_ boollocked_ subfolders - Allow admins to bypass the locked subfolders setting.
- ai_
feature_ Anyavailability - Availability settings for AI features by user class
- allow_
bundle_ boolnames - Are manual Bundle names allowed?
- allow_
user_ boollevel2fa_ override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow_
user_ boollevel_ allowed_ ip_ override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow_
user_ boollevel_ ssl_ override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa_
method_ boolbypass_ for_ ftp_ sftp_ dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa_
method_ boolemail - Is OTP via email two factor authentication allowed?
- allowed2fa_
method_ boolsms - Is SMS two factor authentication allowed?
- allowed2fa_
method_ boolstatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa_
method_ booltotp - Is TOTP two factor authentication allowed?
- allowed2fa_
method_ boolwebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa_
method_ boolyubi - Is yubikey two factor authentication allowed?
- allowed_
countries str - Comma separated list of allowed Country codes
- allowed_
ips str - List of allowed IP addresses
- always_
mkdir_ boolparents - 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_ intretention_ days - Number of days to retain AS2 messages (incoming and outgoing).
- ask_
about_ booloverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle_
activity_ strnotifications - Do Bundle owners receive activity notifications?
- bundle_
expiration int - Site-wide Bundle expiration in days
- bundle_
not_ strfound_ message - Custom error message to show when bundle is not found.
- bundle_
password_ boolrequired - Do Bundles require password protection?
- bundle_
recipient_ Sequence[str]blacklist_ domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle_
recipient_ boolblacklist_ free_ email_ domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle_
registration_ strnotifications - Do Bundle owners receive registration notification?
- bundle_
require_ boolnote - Do Bundles require internal notes?
- bundle_
require_ boolregistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- bundle_
send_ boolone_ time_ password_ to_ recipient_ at_ registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- bundle_
upload_ strreceipt_ notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle_
watermark_ Anyvalue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles_
default_ boolowned_ by_ primary_ group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate_
file_ boolchecksums_ crc32 - Calculate CRC32 checksums for files?
- calculate_
file_ boolchecksums_ md5 - Calculate MD5 checksums for files?
- calculate_
file_ boolchecksums_ sha1 - Calculate SHA1 checksums for files?
- calculate_
file_ boolchecksums_ sha256 - Calculate SHA256 checksums for files?
- color2_
left str - Page link and button color
- color2_
link str - Top bar link color
- color2_
text str - Page link and button color
- color2_
top str - Top bar background color
- color2_
top_ strtext - Top bar text color
- custom_
namespace bool - Is this site using a custom namespace for users?
- dav_
enabled bool - Is WebDAV enabled?
- dav_
user_ boolroot_ enabled - Use user FTP roots also for WebDAV?
- days_
to_ intretain_ backups - Number of days to keep deleted files
- default_
time_ strzone - Site default time zone
- desktop_
app bool - Is the desktop app enabled?
- desktop_
app_ boolsession_ ip_ pinning - Is desktop app session IP pinning enabled?
- desktop_
app_ intsession_ lifetime - Desktop app session lifetime (in hours)
- disable_
all_ boolai_ features - If true, all AI features are disabled for this site.
- disable_
files_ boolcertificate_ generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable_
password_ boolreset - Is password reset disabled?
- disallowed_
countries str - Comma separated list of disallowed Country codes
- document_
edits_ boolin_ bundle_ allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain str
- Custom domain
- domain_
hsts_ boolheader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain_
letsencrypt_ strchain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email str
- Main email for this site
- str
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- folder_
permissions_ boolgroups_ only - If true, permissions for this site must be bound to a group (not a user).
- ftp_
enabled bool - Is FTP enabled?
- group_
admins_ boolcan_ add_ users - Allow group admins to create users in their groups
- group_
admins_ boolcan_ bypass_ user_ lifecycle_ rules - Allow group admins to exempt users in their groups from lifecycle rules
- group_
admins_ boolcan_ delete_ users - Allow group admins to delete users in their groups
- group_
admins_ boolcan_ enable_ disable_ users - Allow group admins to enable or disable users in their groups
- group_
admins_ boolcan_ manage_ group_ memberships - Allow group admins to add or remove existing users in their groups
- group_
admins_ boolcan_ modify_ users - Allow group admins to modify users in their groups
- group_
admins_ boolcan_ reset_ passwords - Allow group admins to reset passwords for users in their groups
- group_
admins_ boolcan_ set_ user_ password - Allow group admins to set password authentication method
- include_
password_ boolin_ welcome_ email - Include password in emails to new users?
- language str
- Site default language
- ldap_
base_ strdn - Base DN for looking up users in LDAP server
- ldap_
domain str - Domain name that will be appended to usernames
- ldap_
enabled bool - Main LDAP setting: is LDAP enabled?
- ldap_
group_ straction - Should we sync groups from LDAP server?
- ldap_
group_ strexclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap_
group_ strinclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap_
host str - LDAP host
- ldap_
host2 str - LDAP backup host
- ldap_
host3 str - LDAP backup host
- ldap_
port int - LDAP port
- ldap_
secure bool - Use secure LDAP?
- ldap_
type str - LDAP type
- ldap_
user_ straction - Should we sync users from LDAP server?
- ldap_
user_ strinclude_ groups - 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 str - Username for signing in to LDAP server.
- ldap_
username_ strfield - LDAP username field
- legacy_
checksums_ boolmode - Use legacy checksums mode?
- login_
help_ strtext - Login help text
- max_
prior_ intpasswords - Number of prior passwords to disallow
- mcp_
dcr_ boolenabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate_
remote_ boolserver_ sync_ to_ sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile_
app bool - Is the mobile app enabled?
- mobile_
app_ boolsession_ ip_ pinning - Is mobile app session IP pinning enabled?
- mobile_
app_ intsession_ lifetime - Mobile app session lifetime (in hours)
- motd_
text str - A message to show users when they connect via FTP or SFTP.
- motd_
use_ boolfor_ ftp - Show message to users connecting via FTP
- motd_
use_ boolfor_ sftp - Show message to users connecting via SFTP
- name str
- Site name
- non_
sso_ boolgroups_ allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non_
sso_ boolusers_ allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- office_
integration_ boolavailable - If true, allows users to use a document editing integration.
- office_
integration_ strtype - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- opt_
out_ boolglobal - Use servers in the USA only?
- password_
min_ intlength - Shortest password length for users
- password_
require_ boolletter - Require a letter in passwords?
- password_
require_ boolmixed - Require lower and upper case letters in passwords?
- password_
require_ boolnumber - Require a number in passwords?
- password_
require_ boolspecial - Require special characters in password?
- password_
require_ boolunbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password_
requirements_ boolapply_ to_ bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password_
validity_ intdays - Number of days password is valid
- pin_
all_ boolremote_ servers_ to_ site_ region - 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_ boolpermissions_ for_ non_ site_ admins - 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_ boolgroups_ only - 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.
- reply_
to_ stremail - Reply-to email for this site
- require2fa bool
- Require two-factor authentication for all users?
- require2fa_
exempt_ boolall_ sso_ users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa_
user_ strtype - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require_
logout_ boolfrom_ bundles_ and_ inboxes - 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.
- restrict_
root_ boolfolder_ behaviors_ to_ site_ admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke_
bundle_ boolaccess_ on_ disable_ or_ delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root_
folder_ boolbehaviors_ apply_ to_ workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session_
expiry_ intminutes - Session expiry in minutes
- sftp_
enabled bool - Is SFTP enabled?
- sftp_
finalize_ boolpartial_ uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp_
host_ strkey_ type - Sftp Host Key Type
- sftp_
insecure_ boolciphers - 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_ booldiffie_ hellman - 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
sftpInsecureCiphersoption. - sftp_
user_ boolroot_ enabled - Use user FTP roots also for SFTP?
- bool
- Allow bundle creation
- show_
request_ boolaccess_ link - Show request access link for users without access? Currently unused.
- show_
user_ boolnotifications_ log_ in_ link - Show log in link in user notifications?
- str
- Custom site footer text for authenticated pages
- site_
header str - Custom site header text for authenticated pages
- str
- Custom site footer text for public pages
- site_
public_ strheader - Custom site header text for public pages
- smtp_
address str - SMTP server hostname or IP
- smtp_
authentication str - SMTP server authentication type
- smtp_
from str - From address to use when mailing through custom SMTP
- smtp_
port int - SMTP server port
- smtp_
username str - SMTP server username
- snapshot_
sharing_ boolenabled - Allow snapshot share links creation
- ssl_
required bool - Is SSL required? Disabling this is insecure.
- subdomain str
- Site subdomain
- uploads_
via_ boolemail_ authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use_
dedicated_ boolips_ for_ smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use_
provided_ boolmodified_ at - Allow uploaders to set
providedModifiedAtfor uploaded files? - user_
lockout bool - Will users be locked out after incorrect login attempts?
- user_
lockout_ intlock_ period - How many hours to lock user out for failed password?
- user_
lockout_ inttries - Number of login tries within
userLockoutWithinhours before users are locked out - user_
lockout_ intwithin - Number of hours for user lockout window
- user_
requests_ boolenabled - Enable User Requests feature
- user_
requests_ boolnotify_ admins - Send email to site admins when a user request is received?
- username_
display str - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users_
can_ boolcreate_ api_ keys - Allow users to create their own API keys?
- users_
can_ boolcreate_ ssh_ keys - Allow users to create their own SSH keys?
- welcome_
custom_ strtext - Custom text send in user welcome email
- welcome_
email_ strcc - Include this email in welcome emails if enabled
- welcome_
email_ boolenabled - Will the welcome email be sent to new users?
- welcome_
email_ strsubject - Include this email subject in welcome emails if enabled
- welcome_
screen str - Does the welcome screen appear?
- windows_
mode_ boolftp - Does FTP user Windows emulation mode?
- active
Sftp NumberHost Key Id - Id of the currently selected custom SFTP Host Key
- additional
Text List<String>File Types - Additional extensions that are considered text files
- admins
Bypass BooleanLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- ai
Feature AnyAvailability - Availability settings for AI features by user class
- allow
Bundle BooleanNames - Are manual Bundle names allowed?
- allow
User BooleanLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow
User BooleanLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow
User BooleanLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa
Method BooleanBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa
Method BooleanEmail - Is OTP via email two factor authentication allowed?
- allowed2fa
Method BooleanSms - Is SMS two factor authentication allowed?
- allowed2fa
Method BooleanStatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa
Method BooleanTotp - Is TOTP two factor authentication allowed?
- allowed2fa
Method BooleanWebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa
Method BooleanYubi - Is yubikey two factor authentication allowed?
- allowed
Countries String - Comma separated list of allowed Country codes
- allowed
Ips String - List of allowed IP addresses
- always
Mkdir BooleanParents - 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.
- as2Message
Retention NumberDays - Number of days to retain AS2 messages (incoming and outgoing).
- ask
About BooleanOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle
Activity StringNotifications - Do Bundle owners receive activity notifications?
- bundle
Expiration Number - Site-wide Bundle expiration in days
- bundle
Not StringFound Message - Custom error message to show when bundle is not found.
- bundle
Password BooleanRequired - Do Bundles require password protection?
- bundle
Recipient List<String>Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle
Recipient BooleanBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle
Registration StringNotifications - Do Bundle owners receive registration notification?
- bundle
Require BooleanNote - Do Bundles require internal notes?
- bundle
Require BooleanRegistration - Do Bundles require registration?
- Boolean
- Do Bundles require recipients for sharing?
- bundle
Send BooleanOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- Boolean
- Do Bundle creators receive receipts of invitations?
- bundle
Upload StringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle
Watermark AnyValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles
Default BooleanOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate
File BooleanChecksums Crc32 - Calculate CRC32 checksums for files?
- calculate
File BooleanChecksums Md5 - Calculate MD5 checksums for files?
- calculate
File BooleanChecksums Sha1 - Calculate SHA1 checksums for files?
- calculate
File BooleanChecksums Sha256 - Calculate SHA256 checksums for files?
- color2Left String
- Page link and button color
- color2Link String
- Top bar link color
- color2Text String
- Page link and button color
- color2Top String
- Top bar background color
- color2Top
Text String - Top bar text color
- custom
Namespace Boolean - Is this site using a custom namespace for users?
- dav
Enabled Boolean - Is WebDAV enabled?
- dav
User BooleanRoot Enabled - Use user FTP roots also for WebDAV?
- days
To NumberRetain Backups - Number of days to keep deleted files
- default
Time StringZone - Site default time zone
- desktop
App Boolean - Is the desktop app enabled?
- desktop
App BooleanSession Ip Pinning - Is desktop app session IP pinning enabled?
- desktop
App NumberSession Lifetime - Desktop app session lifetime (in hours)
- disable
All BooleanAi Features - If true, all AI features are disabled for this site.
- disable
Files BooleanCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable
Password BooleanReset - Is password reset disabled?
- disallowed
Countries String - Comma separated list of disallowed Country codes
- document
Edits BooleanIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain String
- Custom domain
- domain
Hsts BooleanHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain
Letsencrypt StringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email String
- Main email for this site
- String
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp Boolean
- Are FedRAMP security restrictions enabled for this site?
- folder
Permissions BooleanGroups Only - If true, permissions for this site must be bound to a group (not a user).
- ftp
Enabled Boolean - Is FTP enabled?
- group
Admins BooleanCan Add Users - Allow group admins to create users in their groups
- group
Admins BooleanCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- group
Admins BooleanCan Delete Users - Allow group admins to delete users in their groups
- group
Admins BooleanCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- group
Admins BooleanCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- group
Admins BooleanCan Modify Users - Allow group admins to modify users in their groups
- group
Admins BooleanCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- group
Admins BooleanCan Set User Password - Allow group admins to set password authentication method
- include
Password BooleanIn Welcome Email - Include password in emails to new users?
- language String
- Site default language
- ldap
Base StringDn - Base DN for looking up users in LDAP server
- ldap
Domain String - Domain name that will be appended to usernames
- ldap
Enabled Boolean - Main LDAP setting: is LDAP enabled?
- ldap
Group StringAction - Should we sync groups from LDAP server?
- ldap
Group StringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap
Group StringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap
Host String - LDAP host
- ldap
Host2 String - LDAP backup host
- ldap
Host3 String - LDAP backup host
- ldap
Port Number - LDAP port
- ldap
Secure Boolean - Use secure LDAP?
- ldap
Type String - LDAP type
- ldap
User StringAction - Should we sync users from LDAP server?
- ldap
User StringInclude Groups - 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 StringField - LDAP username field
- legacy
Checksums BooleanMode - Use legacy checksums mode?
- login
Help StringText - Login help text
- max
Prior NumberPasswords - Number of prior passwords to disallow
- mcp
Dcr BooleanEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate
Remote BooleanServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile
App Boolean - Is the mobile app enabled?
- mobile
App BooleanSession Ip Pinning - Is mobile app session IP pinning enabled?
- mobile
App NumberSession Lifetime - Mobile app session lifetime (in hours)
- motd
Text String - A message to show users when they connect via FTP or SFTP.
- motd
Use BooleanFor Ftp - Show message to users connecting via FTP
- motd
Use BooleanFor Sftp - Show message to users connecting via SFTP
- name String
- Site name
- non
Sso BooleanGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non
Sso BooleanUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- Boolean
- If true, allows users to use a document editing integration.
- office
Integration StringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- opt
Out BooleanGlobal - Use servers in the USA only?
- password
Min NumberLength - Shortest password length for users
- password
Require BooleanLetter - Require a letter in passwords?
- password
Require BooleanMixed - Require lower and upper case letters in passwords?
- password
Require BooleanNumber - Require a number in passwords?
- password
Require BooleanSpecial - Require special characters in password?
- password
Require BooleanUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password
Requirements BooleanApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password
Validity NumberDays - Number of days password is valid
- pin
All BooleanRemote Servers To Site Region - 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 BooleanPermissions For Non Site Admins - 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 BooleanGroups Only - 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.
- reply
To StringEmail - Reply-to email for this site
- require2fa Boolean
- Require two-factor authentication for all users?
- require2fa
Exempt BooleanAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa
User StringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require
Logout BooleanFrom Bundles And Inboxes - 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.
- restrict
Root BooleanFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke
Bundle BooleanAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root
Folder BooleanBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session
Expiry NumberMinutes - Session expiry in minutes
- sftp
Enabled Boolean - Is SFTP enabled?
- sftp
Finalize BooleanPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp
Host StringKey Type - Sftp Host Key Type
- sftp
Insecure BooleanCiphers - 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 BooleanDiffie Hellman - 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
sftpInsecureCiphersoption. - sftp
User BooleanRoot Enabled - Use user FTP roots also for SFTP?
- Boolean
- Allow bundle creation
- show
Request BooleanAccess Link - Show request access link for users without access? Currently unused.
- show
User BooleanNotifications Log In Link - Show log in link in user notifications?
- String
- Custom site footer text for authenticated pages
- site
Header String - Custom site header text for authenticated pages
- String
- Custom site footer text for public pages
- site
Public StringHeader - 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 Number - SMTP server port
- smtp
Username String - SMTP server username
- snapshot
Sharing BooleanEnabled - Allow snapshot share links creation
- ssl
Required Boolean - Is SSL required? Disabling this is insecure.
- subdomain String
- Site subdomain
- uploads
Via BooleanEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use
Dedicated BooleanIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use
Provided BooleanModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - user
Lockout Boolean - Will users be locked out after incorrect login attempts?
- user
Lockout NumberLock Period - How many hours to lock user out for failed password?
- user
Lockout NumberTries - Number of login tries within
userLockoutWithinhours before users are locked out - user
Lockout NumberWithin - Number of hours for user lockout window
- user
Requests BooleanEnabled - Enable User Requests feature
- user
Requests BooleanNotify Admins - Send email to site admins when a user request is received?
- username
Display String - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users
Can BooleanCreate Api Keys - Allow users to create their own API keys?
- users
Can BooleanCreate Ssh Keys - Allow users to create their own SSH keys?
- welcome
Custom StringText - Custom text send in user welcome email
- welcome
Email StringCc - Include this email in welcome emails if enabled
- welcome
Email BooleanEnabled - Will the welcome email be sent to new users?
- welcome
Email StringSubject - Include this email subject in welcome emails if enabled
- welcome
Screen String - Does the welcome screen appear?
- windows
Mode BooleanFtp - Does FTP user Windows emulation mode?
Outputs
All input properties are implicitly available as output properties. Additionally, the Site resource produces the following output properties:
- Admin
User intId - User ID for the main site administrator
- Bundle
Watermark stringAttachment - 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
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable
Files stringSet At - Can files be modified?
- Login
Page stringBackground Image - Branded login page background
- Logo string
- Branded logo
- Managed
Site objectSettings - List of site settings managed by the parent site
- Next
Billing stringAmount - Next billing amount
- Next
Billing stringDate - 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
- Require2fa
Stop stringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- Session string
- Current session
- Switch
To stringPlan Date - If switching plans, when does the new plan take effect?
- Trial
Days intLeft - Number of days left in trial
- Trial
Until string - When does this Site trial expire?
- User string
- User of current session
- Admin
User intId - User ID for the main site administrator
- Bundle
Watermark stringAttachment - 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
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable
Files stringSet At - Can files be modified?
- Login
Page stringBackground Image - Branded login page background
- Logo string
- Branded logo
- Managed
Site interface{}Settings - List of site settings managed by the parent site
- Next
Billing stringAmount - Next billing amount
- Next
Billing stringDate - 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
- Require2fa
Stop stringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- Session string
- Current session
- Switch
To stringPlan Date - If switching plans, when does the new plan take effect?
- Trial
Days intLeft - Number of days left in trial
- Trial
Until string - When does this Site trial expire?
- User string
- User of current session
- admin_
user_ numberid - User ID for the main site administrator
- bundle_
watermark_ stringattachment - 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
- id string
- The provider-assigned unique ID for this managed resource.
- immutable_
files_ stringset_ at - Can files be modified?
- login_
page_ stringbackground_ image - Branded login page background
- logo string
- Branded logo
- managed_
site_ anysettings - List of site settings managed by the parent site
- next_
billing_ stringamount - Next billing amount
- next_
billing_ stringdate - 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
- require2fa_
stop_ stringtime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- session string
- Current session
- switch_
to_ stringplan_ date - If switching plans, when does the new plan take effect?
- trial_
days_ numberleft - Number of days left in trial
- trial_
until string - When does this Site trial expire?
- user string
- User of current session
- admin
User IntegerId - User ID for the main site administrator
- bundle
Watermark StringAttachment - 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 Boolean - Are notifications disabled?
- hipaa Boolean
- 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
- id String
- The provider-assigned unique ID for this managed resource.
- immutable
Files StringSet At - Can files be modified?
- login
Page StringBackground Image - Branded login page background
- logo String
- Branded logo
- managed
Site ObjectSettings - List of site settings managed by the parent site
- next
Billing StringAmount - Next billing amount
- next
Billing StringDate - Next billing date
- oncehub
Link String - Link to scheduling a meeting with our Sales team
- overdue Boolean
- Is this site's billing overdue?
- phone String
- Site phone number
- require2fa
Stop StringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- session String
- Current session
- switch
To StringPlan Date - If switching plans, when does the new plan take effect?
- trial
Days IntegerLeft - Number of days left in trial
- trial
Until String - When does this Site trial expire?
- user String
- User of current session
- admin
User numberId - User ID for the main site administrator
- bundle
Watermark stringAttachment - 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 boolean - Are notifications disabled?
- hipaa boolean
- 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
- id string
- The provider-assigned unique ID for this managed resource.
- immutable
Files stringSet At - Can files be modified?
- login
Page stringBackground Image - Branded login page background
- logo string
- Branded logo
- managed
Site anySettings - List of site settings managed by the parent site
- next
Billing stringAmount - Next billing amount
- next
Billing stringDate - Next billing date
- oncehub
Link string - Link to scheduling a meeting with our Sales team
- overdue boolean
- Is this site's billing overdue?
- phone string
- Site phone number
- require2fa
Stop stringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- session string
- Current session
- switch
To stringPlan Date - If switching plans, when does the new plan take effect?
- trial
Days numberLeft - Number of days left in trial
- trial
Until string - When does this Site trial expire?
- user string
- User of current session
- admin_
user_ intid - User ID for the main site administrator
- bundle_
watermark_ strattachment - Preview watermark image applied to all bundle items.
- contact_
name str - Site main contact name
- created_
at str - Time this site was created
- currency str
- Preferred currency
- disable_
notifications bool - Are notifications disabled?
- hipaa bool
- Is there a signed HIPAA BAA between Files.com and this site?
- icon128 str
- Branded icon 128x128
- icon16 str
- Branded icon 16x16
- icon32 str
- Branded icon 32x32
- icon48 str
- Branded icon 48x48
- id str
- The provider-assigned unique ID for this managed resource.
- immutable_
files_ strset_ at - Can files be modified?
- login_
page_ strbackground_ image - Branded login page background
- logo str
- Branded logo
- managed_
site_ Anysettings - List of site settings managed by the parent site
- next_
billing_ stramount - Next billing amount
- next_
billing_ strdate - Next billing date
- oncehub_
link str - Link to scheduling a meeting with our Sales team
- overdue bool
- Is this site's billing overdue?
- phone str
- Site phone number
- require2fa_
stop_ strtime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- session str
- Current session
- switch_
to_ strplan_ date - If switching plans, when does the new plan take effect?
- trial_
days_ intleft - Number of days left in trial
- trial_
until str - When does this Site trial expire?
- user str
- User of current session
- admin
User NumberId - User ID for the main site administrator
- bundle
Watermark StringAttachment - 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 Boolean - Are notifications disabled?
- hipaa Boolean
- 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
- id String
- The provider-assigned unique ID for this managed resource.
- immutable
Files StringSet At - Can files be modified?
- login
Page StringBackground Image - Branded login page background
- logo String
- Branded logo
- managed
Site AnySettings - List of site settings managed by the parent site
- next
Billing StringAmount - Next billing amount
- next
Billing StringDate - Next billing date
- oncehub
Link String - Link to scheduling a meeting with our Sales team
- overdue Boolean
- Is this site's billing overdue?
- phone String
- Site phone number
- require2fa
Stop StringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- session String
- Current session
- switch
To StringPlan Date - If switching plans, when does the new plan take effect?
- trial
Days NumberLeft - Number of days left in trial
- trial
Until String - When does this Site trial expire?
- user String
- User of current session
Look up Existing Site Resource
Get an existing Site resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SiteState, opts?: CustomResourceOptions): Site@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active_sftp_host_key_id: Optional[int] = None,
additional_text_file_types: Optional[Sequence[str]] = None,
admin_user_id: Optional[int] = None,
admins_bypass_locked_subfolders: Optional[bool] = None,
ai_feature_availability: Optional[Any] = None,
allow_bundle_names: Optional[bool] = None,
allow_user_level2fa_override: Optional[bool] = None,
allow_user_level_allowed_ip_override: Optional[bool] = None,
allow_user_level_ssl_override: Optional[bool] = None,
allowed2fa_method_bypass_for_ftp_sftp_dav: Optional[bool] = None,
allowed2fa_method_email: Optional[bool] = None,
allowed2fa_method_sms: Optional[bool] = None,
allowed2fa_method_static: Optional[bool] = None,
allowed2fa_method_totp: Optional[bool] = None,
allowed2fa_method_webauthn: Optional[bool] = None,
allowed2fa_method_yubi: Optional[bool] = None,
allowed_countries: Optional[str] = None,
allowed_ips: Optional[str] = None,
always_mkdir_parents: Optional[bool] = None,
as2_message_retention_days: Optional[int] = None,
ask_about_overwrites: Optional[bool] = None,
bundle_activity_notifications: Optional[str] = None,
bundle_expiration: Optional[int] = None,
bundle_not_found_message: Optional[str] = None,
bundle_password_required: Optional[bool] = None,
bundle_recipient_blacklist_domains: Optional[Sequence[str]] = None,
bundle_recipient_blacklist_free_email_domains: Optional[bool] = None,
bundle_registration_notifications: Optional[str] = None,
bundle_require_note: Optional[bool] = None,
bundle_require_registration: Optional[bool] = None,
bundle_require_share_recipient: Optional[bool] = None,
bundle_send_one_time_password_to_recipient_at_registration: Optional[bool] = None,
bundle_send_shared_receipts: Optional[bool] = None,
bundle_upload_receipt_notifications: Optional[str] = None,
bundle_watermark_attachment: Optional[str] = None,
bundle_watermark_value: Optional[Any] = None,
bundles_default_owned_by_primary_group: Optional[bool] = None,
calculate_file_checksums_crc32: Optional[bool] = None,
calculate_file_checksums_md5: Optional[bool] = None,
calculate_file_checksums_sha1: Optional[bool] = None,
calculate_file_checksums_sha256: Optional[bool] = None,
color2_left: Optional[str] = None,
color2_link: Optional[str] = None,
color2_text: Optional[str] = None,
color2_top: Optional[str] = None,
color2_top_text: Optional[str] = None,
contact_name: Optional[str] = None,
created_at: Optional[str] = None,
currency: Optional[str] = None,
custom_namespace: Optional[bool] = None,
dav_enabled: Optional[bool] = None,
dav_user_root_enabled: Optional[bool] = None,
days_to_retain_backups: Optional[int] = None,
default_time_zone: Optional[str] = None,
desktop_app: Optional[bool] = None,
desktop_app_session_ip_pinning: Optional[bool] = None,
desktop_app_session_lifetime: Optional[int] = None,
disable_all_ai_features: Optional[bool] = None,
disable_files_certificate_generation: Optional[bool] = None,
disable_notifications: Optional[bool] = None,
disable_password_reset: Optional[bool] = None,
disallowed_countries: Optional[str] = None,
document_edits_in_bundle_allowed: Optional[bool] = None,
domain: Optional[str] = None,
domain_hsts_header: Optional[bool] = None,
domain_letsencrypt_chain: Optional[str] = None,
email: Optional[str] = None,
email_footer_custom_text: Optional[str] = None,
fedramp: Optional[bool] = None,
folder_permissions_groups_only: Optional[bool] = None,
ftp_enabled: Optional[bool] = None,
group_admins_can_add_users: Optional[bool] = None,
group_admins_can_bypass_user_lifecycle_rules: Optional[bool] = None,
group_admins_can_delete_users: Optional[bool] = None,
group_admins_can_enable_disable_users: Optional[bool] = None,
group_admins_can_manage_group_memberships: Optional[bool] = None,
group_admins_can_modify_users: Optional[bool] = None,
group_admins_can_reset_passwords: Optional[bool] = None,
group_admins_can_set_user_password: Optional[bool] = None,
hipaa: Optional[bool] = None,
icon128: Optional[str] = None,
icon16: Optional[str] = None,
icon32: Optional[str] = None,
icon48: Optional[str] = None,
immutable_files_set_at: Optional[str] = None,
include_password_in_welcome_email: Optional[bool] = None,
language: Optional[str] = None,
ldap_base_dn: Optional[str] = None,
ldap_domain: Optional[str] = None,
ldap_enabled: Optional[bool] = None,
ldap_group_action: Optional[str] = None,
ldap_group_exclusion: Optional[str] = None,
ldap_group_inclusion: Optional[str] = None,
ldap_host: Optional[str] = None,
ldap_host2: Optional[str] = None,
ldap_host3: Optional[str] = None,
ldap_port: Optional[int] = None,
ldap_secure: Optional[bool] = None,
ldap_type: Optional[str] = None,
ldap_user_action: Optional[str] = None,
ldap_user_include_groups: Optional[str] = None,
ldap_username: Optional[str] = None,
ldap_username_field: Optional[str] = None,
legacy_checksums_mode: Optional[bool] = None,
login_help_text: Optional[str] = None,
login_page_background_image: Optional[str] = None,
logo: Optional[str] = None,
managed_site_settings: Optional[Any] = None,
max_prior_passwords: Optional[int] = None,
mcp_dcr_enabled: Optional[bool] = None,
migrate_remote_server_sync_to_sync: Optional[bool] = None,
mobile_app: Optional[bool] = None,
mobile_app_session_ip_pinning: Optional[bool] = None,
mobile_app_session_lifetime: Optional[int] = None,
motd_text: Optional[str] = None,
motd_use_for_ftp: Optional[bool] = None,
motd_use_for_sftp: Optional[bool] = None,
name: Optional[str] = None,
next_billing_amount: Optional[str] = None,
next_billing_date: Optional[str] = None,
non_sso_groups_allowed: Optional[bool] = None,
non_sso_users_allowed: Optional[bool] = None,
office_integration_available: Optional[bool] = None,
office_integration_type: Optional[str] = None,
oncehub_link: Optional[str] = None,
opt_out_global: Optional[bool] = None,
overdue: Optional[bool] = None,
password_min_length: Optional[int] = None,
password_require_letter: Optional[bool] = None,
password_require_mixed: Optional[bool] = None,
password_require_number: Optional[bool] = None,
password_require_special: Optional[bool] = None,
password_require_unbreached: Optional[bool] = None,
password_requirements_apply_to_bundles: Optional[bool] = None,
password_validity_days: Optional[int] = None,
phone: Optional[str] = None,
pin_all_remote_servers_to_site_region: Optional[bool] = None,
prevent_root_permissions_for_non_site_admins: Optional[bool] = None,
protocol_access_groups_only: Optional[bool] = None,
reply_to_email: Optional[str] = None,
require2fa: Optional[bool] = None,
require2fa_exempt_all_sso_users: Optional[bool] = None,
require2fa_stop_time: Optional[str] = None,
require2fa_user_type: Optional[str] = None,
require_logout_from_bundles_and_inboxes: Optional[bool] = None,
restrict_root_folder_behaviors_to_site_admins: Optional[bool] = None,
revoke_bundle_access_on_disable_or_delete: Optional[bool] = None,
root_folder_behaviors_apply_to_workspaces: Optional[bool] = None,
session: Optional[str] = None,
session_expiry_minutes: Optional[int] = None,
sftp_enabled: Optional[bool] = None,
sftp_finalize_partial_uploads: Optional[bool] = None,
sftp_host_key_type: Optional[str] = None,
sftp_insecure_ciphers: Optional[bool] = None,
sftp_insecure_diffie_hellman: Optional[bool] = None,
sftp_user_root_enabled: Optional[bool] = None,
sharing_enabled: Optional[bool] = None,
show_request_access_link: Optional[bool] = None,
show_user_notifications_log_in_link: Optional[bool] = None,
site_footer: Optional[str] = None,
site_header: Optional[str] = None,
site_public_footer: Optional[str] = None,
site_public_header: Optional[str] = None,
smtp_address: Optional[str] = None,
smtp_authentication: Optional[str] = None,
smtp_from: Optional[str] = None,
smtp_port: Optional[int] = None,
smtp_username: Optional[str] = None,
snapshot_sharing_enabled: Optional[bool] = None,
ssl_required: Optional[bool] = None,
subdomain: Optional[str] = None,
switch_to_plan_date: Optional[str] = None,
trial_days_left: Optional[int] = None,
trial_until: Optional[str] = None,
uploads_via_email_authentication: Optional[bool] = None,
use_dedicated_ips_for_smtp: Optional[bool] = None,
use_provided_modified_at: Optional[bool] = None,
user: Optional[str] = None,
user_lockout: Optional[bool] = None,
user_lockout_lock_period: Optional[int] = None,
user_lockout_tries: Optional[int] = None,
user_lockout_within: Optional[int] = None,
user_requests_enabled: Optional[bool] = None,
user_requests_notify_admins: Optional[bool] = None,
username_display: Optional[str] = None,
users_can_create_api_keys: Optional[bool] = None,
users_can_create_ssh_keys: Optional[bool] = None,
welcome_custom_text: Optional[str] = None,
welcome_email_cc: Optional[str] = None,
welcome_email_enabled: Optional[bool] = None,
welcome_email_subject: Optional[str] = None,
welcome_screen: Optional[str] = None,
windows_mode_ftp: Optional[bool] = None) -> Sitefunc GetSite(ctx *Context, name string, id IDInput, state *SiteState, opts ...ResourceOption) (*Site, error)public static Site Get(string name, Input<string> id, SiteState? state, CustomResourceOptions? opts = null)public static Site get(String name, Output<String> id, SiteState state, CustomResourceOptions options)resources: _: type: filescom:Site get: id: ${id}import {
to = filescom_site.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Active
Sftp intHost Key Id - Id of the currently selected custom SFTP Host Key
- Additional
Text List<string>File Types - Additional extensions that are considered text files
- Admin
User intId - User ID for the main site administrator
- Admins
Bypass boolLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- Ai
Feature objectAvailability - Availability settings for AI features by user class
- Allow
Bundle boolNames - Are manual Bundle names allowed?
- Allow
User boolLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- Allow
User boolLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- Allow
User boolLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- Allowed2fa
Method boolBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- Allowed2fa
Method boolEmail - Is OTP via email two factor authentication allowed?
- Allowed2fa
Method boolSms - Is SMS two factor authentication allowed?
- Allowed2fa
Method boolStatic - Is OTP via static codes for two factor authentication allowed?
- Allowed2fa
Method boolTotp - Is TOTP two factor authentication allowed?
- Allowed2fa
Method boolWebauthn - Is WebAuthn two factor authentication allowed?
- Allowed2fa
Method boolYubi - Is yubikey two factor authentication allowed?
- Allowed
Countries string - Comma separated list of allowed Country codes
- Allowed
Ips string - List of allowed IP addresses
- Always
Mkdir boolParents - 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.
- As2Message
Retention intDays - Number of days to retain AS2 messages (incoming and outgoing).
- Ask
About boolOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- Bundle
Activity stringNotifications - Do Bundle owners receive activity notifications?
- Bundle
Expiration int - Site-wide Bundle expiration in days
- Bundle
Not stringFound Message - Custom error message to show when bundle is not found.
- Bundle
Password boolRequired - Do Bundles require password protection?
- Bundle
Recipient List<string>Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- Bundle
Recipient boolBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- Bundle
Registration stringNotifications - Do Bundle owners receive registration notification?
- Bundle
Require boolNote - Do Bundles require internal notes?
- Bundle
Require boolRegistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- Bundle
Send boolOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- Bundle
Upload stringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- Bundle
Watermark stringAttachment - Preview watermark image applied to all bundle items.
- Bundle
Watermark objectValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- Bundles
Default boolOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- Calculate
File boolChecksums Crc32 - Calculate CRC32 checksums for files?
- Calculate
File boolChecksums Md5 - Calculate MD5 checksums for files?
- Calculate
File boolChecksums Sha1 - Calculate SHA1 checksums for files?
- Calculate
File boolChecksums Sha256 - Calculate SHA256 checksums for files?
- Color2Left string
- Page link and button color
- Color2Link string
- Top bar link color
- Color2Text string
- Page link and button color
- Color2Top string
- Top bar background color
- Color2Top
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 boolRoot Enabled - Use user FTP roots also for WebDAV?
- Days
To intRetain Backups - Number of days to keep deleted files
- Default
Time stringZone - Site default time zone
- Desktop
App bool - Is the desktop app enabled?
- Desktop
App boolSession Ip Pinning - Is desktop app session IP pinning enabled?
- Desktop
App intSession Lifetime - Desktop app session lifetime (in hours)
- Disable
All boolAi Features - If true, all AI features are disabled for this site.
- Disable
Files boolCertificate Generation - 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 boolReset - Is password reset disabled?
- Disallowed
Countries string - Comma separated list of disallowed Country codes
- Document
Edits boolIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- Domain string
- Custom domain
- Domain
Hsts boolHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- Domain
Letsencrypt stringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- Email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- Fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- Folder
Permissions boolGroups Only - If true, permissions for this site must be bound to a group (not a user).
- Ftp
Enabled bool - Is FTP enabled?
- Group
Admins boolCan Add Users - Allow group admins to create users in their groups
- Group
Admins boolCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- Group
Admins boolCan Delete Users - Allow group admins to delete users in their groups
- Group
Admins boolCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- Group
Admins boolCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- Group
Admins boolCan Modify Users - Allow group admins to modify users in their groups
- Group
Admins boolCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- Group
Admins boolCan Set User Password - 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 stringSet At - Can files be modified?
- Include
Password boolIn Welcome Email - Include password in emails to new users?
- Language string
- Site default language
- Ldap
Base stringDn - 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 stringAction - Should we sync groups from LDAP server?
- Ldap
Group stringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- Ldap
Group stringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- Ldap
Host string - LDAP host
- Ldap
Host2 string - LDAP backup host
- Ldap
Host3 string - LDAP backup host
- Ldap
Port int - LDAP port
- Ldap
Secure bool - Use secure LDAP?
- Ldap
Type string - LDAP type
- Ldap
User stringAction - Should we sync users from LDAP server?
- Ldap
User stringInclude Groups - 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 stringField - LDAP username field
- Legacy
Checksums boolMode - Use legacy checksums mode?
- Login
Help stringText - Login help text
- Login
Page stringBackground Image - Branded login page background
- Logo string
- Branded logo
- Managed
Site objectSettings - List of site settings managed by the parent site
- Max
Prior intPasswords - Number of prior passwords to disallow
- Mcp
Dcr boolEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- Migrate
Remote boolServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- Mobile
App bool - Is the mobile app enabled?
- Mobile
App boolSession Ip Pinning - Is mobile app session IP pinning enabled?
- Mobile
App intSession Lifetime - Mobile app session lifetime (in hours)
- Motd
Text string - A message to show users when they connect via FTP or SFTP.
- Motd
Use boolFor Ftp - Show message to users connecting via FTP
- Motd
Use boolFor Sftp - Show message to users connecting via SFTP
- Name string
- Site name
- Next
Billing stringAmount - Next billing amount
- Next
Billing stringDate - Next billing date
- Non
Sso boolGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- Non
Sso boolUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- bool
- If true, allows users to use a document editing integration.
- Office
Integration stringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- Oncehub
Link string - Link to scheduling a meeting with our Sales team
- Opt
Out boolGlobal - Use servers in the USA only?
- Overdue bool
- Is this site's billing overdue?
- Password
Min intLength - Shortest password length for users
- Password
Require boolLetter - Require a letter in passwords?
- Password
Require boolMixed - Require lower and upper case letters in passwords?
- Password
Require boolNumber - Require a number in passwords?
- Password
Require boolSpecial - Require special characters in password?
- Password
Require boolUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- Password
Requirements boolApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- Password
Validity intDays - Number of days password is valid
- Phone string
- Site phone number
- Pin
All boolRemote Servers To Site Region - 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 boolPermissions For Non Site Admins - 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 boolGroups Only - 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.
- Reply
To stringEmail - Reply-to email for this site
- Require2fa bool
- Require two-factor authentication for all users?
- Require2fa
Exempt boolAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- Require2fa
Stop stringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- Require2fa
User stringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - Require
Logout boolFrom Bundles And Inboxes - 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.
- Restrict
Root boolFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- Revoke
Bundle boolAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- Root
Folder boolBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- Session string
- Current session
- Session
Expiry intMinutes - Session expiry in minutes
- Sftp
Enabled bool - Is SFTP enabled?
- Sftp
Finalize boolPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- Sftp
Host stringKey Type - Sftp Host Key Type
- Sftp
Insecure boolCiphers - 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 boolDiffie Hellman - 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
sftpInsecureCiphersoption. - Sftp
User boolRoot Enabled - Use user FTP roots also for SFTP?
- Sharing
Enabled bool - Allow bundle creation
- Show
Request boolAccess Link - Show request access link for users without access? Currently unused.
- Show
User boolNotifications Log In Link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- Site
Header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- Site
Public stringHeader - 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 int - SMTP server port
- Smtp
Username string - SMTP server username
- Snapshot
Sharing boolEnabled - Allow snapshot share links creation
- Ssl
Required bool - Is SSL required? Disabling this is insecure.
- Subdomain string
- Site subdomain
- Switch
To stringPlan Date - If switching plans, when does the new plan take effect?
- Trial
Days intLeft - Number of days left in trial
- Trial
Until string - When does this Site trial expire?
- Uploads
Via boolEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- Use
Dedicated boolIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- Use
Provided boolModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - User string
- User of current session
- User
Lockout bool - Will users be locked out after incorrect login attempts?
- User
Lockout intLock Period - How many hours to lock user out for failed password?
- User
Lockout intTries - Number of login tries within
userLockoutWithinhours before users are locked out - User
Lockout intWithin - Number of hours for user lockout window
- User
Requests boolEnabled - Enable User Requests feature
- User
Requests boolNotify Admins - Send email to site admins when a user request is received?
- Username
Display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - Users
Can boolCreate Api Keys - Allow users to create their own API keys?
- Users
Can boolCreate Ssh Keys - Allow users to create their own SSH keys?
- Welcome
Custom stringText - Custom text send in user welcome email
- Welcome
Email stringCc - Include this email in welcome emails if enabled
- Welcome
Email boolEnabled - Will the welcome email be sent to new users?
- Welcome
Email stringSubject - Include this email subject in welcome emails if enabled
- Welcome
Screen string - Does the welcome screen appear?
- Windows
Mode boolFtp - Does FTP user Windows emulation mode?
- Active
Sftp intHost Key Id - Id of the currently selected custom SFTP Host Key
- Additional
Text []stringFile Types - Additional extensions that are considered text files
- Admin
User intId - User ID for the main site administrator
- Admins
Bypass boolLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- Ai
Feature interface{}Availability - Availability settings for AI features by user class
- Allow
Bundle boolNames - Are manual Bundle names allowed?
- Allow
User boolLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- Allow
User boolLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- Allow
User boolLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- Allowed2fa
Method boolBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- Allowed2fa
Method boolEmail - Is OTP via email two factor authentication allowed?
- Allowed2fa
Method boolSms - Is SMS two factor authentication allowed?
- Allowed2fa
Method boolStatic - Is OTP via static codes for two factor authentication allowed?
- Allowed2fa
Method boolTotp - Is TOTP two factor authentication allowed?
- Allowed2fa
Method boolWebauthn - Is WebAuthn two factor authentication allowed?
- Allowed2fa
Method boolYubi - Is yubikey two factor authentication allowed?
- Allowed
Countries string - Comma separated list of allowed Country codes
- Allowed
Ips string - List of allowed IP addresses
- Always
Mkdir boolParents - 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.
- As2Message
Retention intDays - Number of days to retain AS2 messages (incoming and outgoing).
- Ask
About boolOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- Bundle
Activity stringNotifications - Do Bundle owners receive activity notifications?
- Bundle
Expiration int - Site-wide Bundle expiration in days
- Bundle
Not stringFound Message - Custom error message to show when bundle is not found.
- Bundle
Password boolRequired - Do Bundles require password protection?
- Bundle
Recipient []stringBlacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- Bundle
Recipient boolBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- Bundle
Registration stringNotifications - Do Bundle owners receive registration notification?
- Bundle
Require boolNote - Do Bundles require internal notes?
- Bundle
Require boolRegistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- Bundle
Send boolOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- Bundle
Upload stringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- Bundle
Watermark stringAttachment - Preview watermark image applied to all bundle items.
- Bundle
Watermark interface{}Value - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- Bundles
Default boolOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- Calculate
File boolChecksums Crc32 - Calculate CRC32 checksums for files?
- Calculate
File boolChecksums Md5 - Calculate MD5 checksums for files?
- Calculate
File boolChecksums Sha1 - Calculate SHA1 checksums for files?
- Calculate
File boolChecksums Sha256 - Calculate SHA256 checksums for files?
- Color2Left string
- Page link and button color
- Color2Link string
- Top bar link color
- Color2Text string
- Page link and button color
- Color2Top string
- Top bar background color
- Color2Top
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 boolRoot Enabled - Use user FTP roots also for WebDAV?
- Days
To intRetain Backups - Number of days to keep deleted files
- Default
Time stringZone - Site default time zone
- Desktop
App bool - Is the desktop app enabled?
- Desktop
App boolSession Ip Pinning - Is desktop app session IP pinning enabled?
- Desktop
App intSession Lifetime - Desktop app session lifetime (in hours)
- Disable
All boolAi Features - If true, all AI features are disabled for this site.
- Disable
Files boolCertificate Generation - 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 boolReset - Is password reset disabled?
- Disallowed
Countries string - Comma separated list of disallowed Country codes
- Document
Edits boolIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- Domain string
- Custom domain
- Domain
Hsts boolHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- Domain
Letsencrypt stringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- Email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- Fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- Folder
Permissions boolGroups Only - If true, permissions for this site must be bound to a group (not a user).
- Ftp
Enabled bool - Is FTP enabled?
- Group
Admins boolCan Add Users - Allow group admins to create users in their groups
- Group
Admins boolCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- Group
Admins boolCan Delete Users - Allow group admins to delete users in their groups
- Group
Admins boolCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- Group
Admins boolCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- Group
Admins boolCan Modify Users - Allow group admins to modify users in their groups
- Group
Admins boolCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- Group
Admins boolCan Set User Password - 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 stringSet At - Can files be modified?
- Include
Password boolIn Welcome Email - Include password in emails to new users?
- Language string
- Site default language
- Ldap
Base stringDn - 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 stringAction - Should we sync groups from LDAP server?
- Ldap
Group stringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- Ldap
Group stringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- Ldap
Host string - LDAP host
- Ldap
Host2 string - LDAP backup host
- Ldap
Host3 string - LDAP backup host
- Ldap
Port int - LDAP port
- Ldap
Secure bool - Use secure LDAP?
- Ldap
Type string - LDAP type
- Ldap
User stringAction - Should we sync users from LDAP server?
- Ldap
User stringInclude Groups - 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 stringField - LDAP username field
- Legacy
Checksums boolMode - Use legacy checksums mode?
- Login
Help stringText - Login help text
- Login
Page stringBackground Image - Branded login page background
- Logo string
- Branded logo
- Managed
Site interface{}Settings - List of site settings managed by the parent site
- Max
Prior intPasswords - Number of prior passwords to disallow
- Mcp
Dcr boolEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- Migrate
Remote boolServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- Mobile
App bool - Is the mobile app enabled?
- Mobile
App boolSession Ip Pinning - Is mobile app session IP pinning enabled?
- Mobile
App intSession Lifetime - Mobile app session lifetime (in hours)
- Motd
Text string - A message to show users when they connect via FTP or SFTP.
- Motd
Use boolFor Ftp - Show message to users connecting via FTP
- Motd
Use boolFor Sftp - Show message to users connecting via SFTP
- Name string
- Site name
- Next
Billing stringAmount - Next billing amount
- Next
Billing stringDate - Next billing date
- Non
Sso boolGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- Non
Sso boolUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- bool
- If true, allows users to use a document editing integration.
- Office
Integration stringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- Oncehub
Link string - Link to scheduling a meeting with our Sales team
- Opt
Out boolGlobal - Use servers in the USA only?
- Overdue bool
- Is this site's billing overdue?
- Password
Min intLength - Shortest password length for users
- Password
Require boolLetter - Require a letter in passwords?
- Password
Require boolMixed - Require lower and upper case letters in passwords?
- Password
Require boolNumber - Require a number in passwords?
- Password
Require boolSpecial - Require special characters in password?
- Password
Require boolUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- Password
Requirements boolApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- Password
Validity intDays - Number of days password is valid
- Phone string
- Site phone number
- Pin
All boolRemote Servers To Site Region - 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 boolPermissions For Non Site Admins - 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 boolGroups Only - 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.
- Reply
To stringEmail - Reply-to email for this site
- Require2fa bool
- Require two-factor authentication for all users?
- Require2fa
Exempt boolAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- Require2fa
Stop stringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- Require2fa
User stringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - Require
Logout boolFrom Bundles And Inboxes - 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.
- Restrict
Root boolFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- Revoke
Bundle boolAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- Root
Folder boolBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- Session string
- Current session
- Session
Expiry intMinutes - Session expiry in minutes
- Sftp
Enabled bool - Is SFTP enabled?
- Sftp
Finalize boolPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- Sftp
Host stringKey Type - Sftp Host Key Type
- Sftp
Insecure boolCiphers - 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 boolDiffie Hellman - 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
sftpInsecureCiphersoption. - Sftp
User boolRoot Enabled - Use user FTP roots also for SFTP?
- Sharing
Enabled bool - Allow bundle creation
- Show
Request boolAccess Link - Show request access link for users without access? Currently unused.
- Show
User boolNotifications Log In Link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- Site
Header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- Site
Public stringHeader - 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 int - SMTP server port
- Smtp
Username string - SMTP server username
- Snapshot
Sharing boolEnabled - Allow snapshot share links creation
- Ssl
Required bool - Is SSL required? Disabling this is insecure.
- Subdomain string
- Site subdomain
- Switch
To stringPlan Date - If switching plans, when does the new plan take effect?
- Trial
Days intLeft - Number of days left in trial
- Trial
Until string - When does this Site trial expire?
- Uploads
Via boolEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- Use
Dedicated boolIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- Use
Provided boolModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - User string
- User of current session
- User
Lockout bool - Will users be locked out after incorrect login attempts?
- User
Lockout intLock Period - How many hours to lock user out for failed password?
- User
Lockout intTries - Number of login tries within
userLockoutWithinhours before users are locked out - User
Lockout intWithin - Number of hours for user lockout window
- User
Requests boolEnabled - Enable User Requests feature
- User
Requests boolNotify Admins - Send email to site admins when a user request is received?
- Username
Display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - Users
Can boolCreate Api Keys - Allow users to create their own API keys?
- Users
Can boolCreate Ssh Keys - Allow users to create their own SSH keys?
- Welcome
Custom stringText - Custom text send in user welcome email
- Welcome
Email stringCc - Include this email in welcome emails if enabled
- Welcome
Email boolEnabled - Will the welcome email be sent to new users?
- Welcome
Email stringSubject - Include this email subject in welcome emails if enabled
- Welcome
Screen string - Does the welcome screen appear?
- Windows
Mode boolFtp - Does FTP user Windows emulation mode?
- active_
sftp_ numberhost_ key_ id - Id of the currently selected custom SFTP Host Key
- additional_
text_ list(string)file_ types - Additional extensions that are considered text files
- admin_
user_ numberid - User ID for the main site administrator
- admins_
bypass_ boollocked_ subfolders - Allow admins to bypass the locked subfolders setting.
- ai_
feature_ anyavailability - Availability settings for AI features by user class
- allow_
bundle_ boolnames - Are manual Bundle names allowed?
- allow_
user_ boollevel2fa_ override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow_
user_ boollevel_ allowed_ ip_ override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow_
user_ boollevel_ ssl_ override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa_
method_ boolbypass_ for_ ftp_ sftp_ dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa_
method_ boolemail - Is OTP via email two factor authentication allowed?
- allowed2fa_
method_ boolsms - Is SMS two factor authentication allowed?
- allowed2fa_
method_ boolstatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa_
method_ booltotp - Is TOTP two factor authentication allowed?
- allowed2fa_
method_ boolwebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa_
method_ boolyubi - Is yubikey two factor authentication allowed?
- allowed_
countries string - Comma separated list of allowed Country codes
- allowed_
ips string - List of allowed IP addresses
- always_
mkdir_ boolparents - 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_ numberretention_ days - Number of days to retain AS2 messages (incoming and outgoing).
- ask_
about_ booloverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle_
activity_ stringnotifications - Do Bundle owners receive activity notifications?
- bundle_
expiration number - Site-wide Bundle expiration in days
- bundle_
not_ stringfound_ message - Custom error message to show when bundle is not found.
- bundle_
password_ boolrequired - Do Bundles require password protection?
- bundle_
recipient_ list(string)blacklist_ domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle_
recipient_ boolblacklist_ free_ email_ domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle_
registration_ stringnotifications - Do Bundle owners receive registration notification?
- bundle_
require_ boolnote - Do Bundles require internal notes?
- bundle_
require_ boolregistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- bundle_
send_ boolone_ time_ password_ to_ recipient_ at_ registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- bundle_
upload_ stringreceipt_ notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle_
watermark_ stringattachment - Preview watermark image applied to all bundle items.
- bundle_
watermark_ anyvalue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles_
default_ boolowned_ by_ primary_ group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate_
file_ boolchecksums_ crc32 - Calculate CRC32 checksums for files?
- calculate_
file_ boolchecksums_ md5 - Calculate MD5 checksums for files?
- calculate_
file_ boolchecksums_ sha1 - Calculate SHA1 checksums for files?
- calculate_
file_ boolchecksums_ sha256 - Calculate SHA256 checksums for files?
- 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_ stringtext - 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_ boolroot_ enabled - Use user FTP roots also for WebDAV?
- days_
to_ numberretain_ backups - Number of days to keep deleted files
- default_
time_ stringzone - Site default time zone
- desktop_
app bool - Is the desktop app enabled?
- desktop_
app_ boolsession_ ip_ pinning - Is desktop app session IP pinning enabled?
- desktop_
app_ numbersession_ lifetime - Desktop app session lifetime (in hours)
- disable_
all_ boolai_ features - If true, all AI features are disabled for this site.
- disable_
files_ boolcertificate_ generation - 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_ boolreset - Is password reset disabled?
- disallowed_
countries string - Comma separated list of disallowed Country codes
- document_
edits_ boolin_ bundle_ allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain string
- Custom domain
- domain_
hsts_ boolheader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain_
letsencrypt_ stringchain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- folder_
permissions_ boolgroups_ only - If true, permissions for this site must be bound to a group (not a user).
- ftp_
enabled bool - Is FTP enabled?
- group_
admins_ boolcan_ add_ users - Allow group admins to create users in their groups
- group_
admins_ boolcan_ bypass_ user_ lifecycle_ rules - Allow group admins to exempt users in their groups from lifecycle rules
- group_
admins_ boolcan_ delete_ users - Allow group admins to delete users in their groups
- group_
admins_ boolcan_ enable_ disable_ users - Allow group admins to enable or disable users in their groups
- group_
admins_ boolcan_ manage_ group_ memberships - Allow group admins to add or remove existing users in their groups
- group_
admins_ boolcan_ modify_ users - Allow group admins to modify users in their groups
- group_
admins_ boolcan_ reset_ passwords - Allow group admins to reset passwords for users in their groups
- group_
admins_ boolcan_ set_ user_ password - 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_ stringset_ at - Can files be modified?
- include_
password_ boolin_ welcome_ email - Include password in emails to new users?
- language string
- Site default language
- ldap_
base_ stringdn - 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_ stringaction - Should we sync groups from LDAP server?
- ldap_
group_ stringexclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap_
group_ stringinclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap_
host string - LDAP host
- ldap_
host2 string - LDAP backup host
- ldap_
host3 string - LDAP backup host
- ldap_
port number - LDAP port
- ldap_
secure bool - Use secure LDAP?
- ldap_
type string - LDAP type
- ldap_
user_ stringaction - Should we sync users from LDAP server?
- ldap_
user_ stringinclude_ groups - 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_ stringfield - LDAP username field
- legacy_
checksums_ boolmode - Use legacy checksums mode?
- login_
help_ stringtext - Login help text
- login_
page_ stringbackground_ image - Branded login page background
- logo string
- Branded logo
- managed_
site_ anysettings - List of site settings managed by the parent site
- max_
prior_ numberpasswords - Number of prior passwords to disallow
- mcp_
dcr_ boolenabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate_
remote_ boolserver_ sync_ to_ sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile_
app bool - Is the mobile app enabled?
- mobile_
app_ boolsession_ ip_ pinning - Is mobile app session IP pinning enabled?
- mobile_
app_ numbersession_ lifetime - Mobile app session lifetime (in hours)
- motd_
text string - A message to show users when they connect via FTP or SFTP.
- motd_
use_ boolfor_ ftp - Show message to users connecting via FTP
- motd_
use_ boolfor_ sftp - Show message to users connecting via SFTP
- name string
- Site name
- next_
billing_ stringamount - Next billing amount
- next_
billing_ stringdate - Next billing date
- non_
sso_ boolgroups_ allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non_
sso_ boolusers_ allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- office_
integration_ boolavailable - If true, allows users to use a document editing integration.
- office_
integration_ stringtype - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- oncehub_
link string - Link to scheduling a meeting with our Sales team
- opt_
out_ boolglobal - Use servers in the USA only?
- overdue bool
- Is this site's billing overdue?
- password_
min_ numberlength - Shortest password length for users
- password_
require_ boolletter - Require a letter in passwords?
- password_
require_ boolmixed - Require lower and upper case letters in passwords?
- password_
require_ boolnumber - Require a number in passwords?
- password_
require_ boolspecial - Require special characters in password?
- password_
require_ boolunbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password_
requirements_ boolapply_ to_ bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password_
validity_ numberdays - Number of days password is valid
- phone string
- Site phone number
- pin_
all_ boolremote_ servers_ to_ site_ region - 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_ boolpermissions_ for_ non_ site_ admins - 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_ boolgroups_ only - 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.
- reply_
to_ stringemail - Reply-to email for this site
- require2fa bool
- Require two-factor authentication for all users?
- require2fa_
exempt_ boolall_ sso_ users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa_
stop_ stringtime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- require2fa_
user_ stringtype - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require_
logout_ boolfrom_ bundles_ and_ inboxes - 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.
- restrict_
root_ boolfolder_ behaviors_ to_ site_ admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke_
bundle_ boolaccess_ on_ disable_ or_ delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root_
folder_ boolbehaviors_ apply_ to_ workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session string
- Current session
- session_
expiry_ numberminutes - Session expiry in minutes
- sftp_
enabled bool - Is SFTP enabled?
- sftp_
finalize_ boolpartial_ uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp_
host_ stringkey_ type - Sftp Host Key Type
- sftp_
insecure_ boolciphers - 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_ booldiffie_ hellman - 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
sftpInsecureCiphersoption. - sftp_
user_ boolroot_ enabled - Use user FTP roots also for SFTP?
- sharing_
enabled bool - Allow bundle creation
- show_
request_ boolaccess_ link - Show request access link for users without access? Currently unused.
- show_
user_ boolnotifications_ log_ in_ link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- site_
header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- site_
public_ stringheader - 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 number - SMTP server port
- smtp_
username string - SMTP server username
- snapshot_
sharing_ boolenabled - Allow snapshot share links creation
- ssl_
required bool - Is SSL required? Disabling this is insecure.
- subdomain string
- Site subdomain
- switch_
to_ stringplan_ date - If switching plans, when does the new plan take effect?
- trial_
days_ numberleft - Number of days left in trial
- trial_
until string - When does this Site trial expire?
- uploads_
via_ boolemail_ authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use_
dedicated_ boolips_ for_ smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use_
provided_ boolmodified_ at - Allow uploaders to set
providedModifiedAtfor uploaded files? - user string
- User of current session
- user_
lockout bool - Will users be locked out after incorrect login attempts?
- user_
lockout_ numberlock_ period - How many hours to lock user out for failed password?
- user_
lockout_ numbertries - Number of login tries within
userLockoutWithinhours before users are locked out - user_
lockout_ numberwithin - Number of hours for user lockout window
- user_
requests_ boolenabled - Enable User Requests feature
- user_
requests_ boolnotify_ admins - Send email to site admins when a user request is received?
- username_
display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users_
can_ boolcreate_ api_ keys - Allow users to create their own API keys?
- users_
can_ boolcreate_ ssh_ keys - Allow users to create their own SSH keys?
- welcome_
custom_ stringtext - Custom text send in user welcome email
- welcome_
email_ stringcc - Include this email in welcome emails if enabled
- welcome_
email_ boolenabled - Will the welcome email be sent to new users?
- welcome_
email_ stringsubject - Include this email subject in welcome emails if enabled
- welcome_
screen string - Does the welcome screen appear?
- windows_
mode_ boolftp - Does FTP user Windows emulation mode?
- active
Sftp IntegerHost Key Id - Id of the currently selected custom SFTP Host Key
- additional
Text List<String>File Types - Additional extensions that are considered text files
- admin
User IntegerId - User ID for the main site administrator
- admins
Bypass BooleanLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- ai
Feature ObjectAvailability - Availability settings for AI features by user class
- allow
Bundle BooleanNames - Are manual Bundle names allowed?
- allow
User BooleanLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow
User BooleanLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow
User BooleanLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa
Method BooleanBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa
Method BooleanEmail - Is OTP via email two factor authentication allowed?
- allowed2fa
Method BooleanSms - Is SMS two factor authentication allowed?
- allowed2fa
Method BooleanStatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa
Method BooleanTotp - Is TOTP two factor authentication allowed?
- allowed2fa
Method BooleanWebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa
Method BooleanYubi - Is yubikey two factor authentication allowed?
- allowed
Countries String - Comma separated list of allowed Country codes
- allowed
Ips String - List of allowed IP addresses
- always
Mkdir BooleanParents - 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.
- as2Message
Retention IntegerDays - Number of days to retain AS2 messages (incoming and outgoing).
- ask
About BooleanOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle
Activity StringNotifications - Do Bundle owners receive activity notifications?
- bundle
Expiration Integer - Site-wide Bundle expiration in days
- bundle
Not StringFound Message - Custom error message to show when bundle is not found.
- bundle
Password BooleanRequired - Do Bundles require password protection?
- bundle
Recipient List<String>Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle
Recipient BooleanBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle
Registration StringNotifications - Do Bundle owners receive registration notification?
- bundle
Require BooleanNote - Do Bundles require internal notes?
- bundle
Require BooleanRegistration - Do Bundles require registration?
- Boolean
- Do Bundles require recipients for sharing?
- bundle
Send BooleanOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- Boolean
- Do Bundle creators receive receipts of invitations?
- bundle
Upload StringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle
Watermark StringAttachment - Preview watermark image applied to all bundle items.
- bundle
Watermark ObjectValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles
Default BooleanOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate
File BooleanChecksums Crc32 - Calculate CRC32 checksums for files?
- calculate
File BooleanChecksums Md5 - Calculate MD5 checksums for files?
- calculate
File BooleanChecksums Sha1 - Calculate SHA1 checksums for files?
- calculate
File BooleanChecksums Sha256 - Calculate SHA256 checksums for files?
- color2Left String
- Page link and button color
- color2Link String
- Top bar link color
- color2Text String
- Page link and button color
- color2Top String
- Top bar background color
- color2Top
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 Boolean - Is this site using a custom namespace for users?
- dav
Enabled Boolean - Is WebDAV enabled?
- dav
User BooleanRoot Enabled - Use user FTP roots also for WebDAV?
- days
To IntegerRetain Backups - Number of days to keep deleted files
- default
Time StringZone - Site default time zone
- desktop
App Boolean - Is the desktop app enabled?
- desktop
App BooleanSession Ip Pinning - Is desktop app session IP pinning enabled?
- desktop
App IntegerSession Lifetime - Desktop app session lifetime (in hours)
- disable
All BooleanAi Features - If true, all AI features are disabled for this site.
- disable
Files BooleanCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable
Notifications Boolean - Are notifications disabled?
- disable
Password BooleanReset - Is password reset disabled?
- disallowed
Countries String - Comma separated list of disallowed Country codes
- document
Edits BooleanIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain String
- Custom domain
- domain
Hsts BooleanHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain
Letsencrypt StringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email String
- Main email for this site
- String
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp Boolean
- Are FedRAMP security restrictions enabled for this site?
- folder
Permissions BooleanGroups Only - If true, permissions for this site must be bound to a group (not a user).
- ftp
Enabled Boolean - Is FTP enabled?
- group
Admins BooleanCan Add Users - Allow group admins to create users in their groups
- group
Admins BooleanCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- group
Admins BooleanCan Delete Users - Allow group admins to delete users in their groups
- group
Admins BooleanCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- group
Admins BooleanCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- group
Admins BooleanCan Modify Users - Allow group admins to modify users in their groups
- group
Admins BooleanCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- group
Admins BooleanCan Set User Password - Allow group admins to set password authentication method
- hipaa Boolean
- 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 StringSet At - Can files be modified?
- include
Password BooleanIn Welcome Email - Include password in emails to new users?
- language String
- Site default language
- ldap
Base StringDn - Base DN for looking up users in LDAP server
- ldap
Domain String - Domain name that will be appended to usernames
- ldap
Enabled Boolean - Main LDAP setting: is LDAP enabled?
- ldap
Group StringAction - Should we sync groups from LDAP server?
- ldap
Group StringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap
Group StringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap
Host String - LDAP host
- ldap
Host2 String - LDAP backup host
- ldap
Host3 String - LDAP backup host
- ldap
Port Integer - LDAP port
- ldap
Secure Boolean - Use secure LDAP?
- ldap
Type String - LDAP type
- ldap
User StringAction - Should we sync users from LDAP server?
- ldap
User StringInclude Groups - 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 StringField - LDAP username field
- legacy
Checksums BooleanMode - Use legacy checksums mode?
- login
Help StringText - Login help text
- login
Page StringBackground Image - Branded login page background
- logo String
- Branded logo
- managed
Site ObjectSettings - List of site settings managed by the parent site
- max
Prior IntegerPasswords - Number of prior passwords to disallow
- mcp
Dcr BooleanEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate
Remote BooleanServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile
App Boolean - Is the mobile app enabled?
- mobile
App BooleanSession Ip Pinning - Is mobile app session IP pinning enabled?
- mobile
App IntegerSession Lifetime - Mobile app session lifetime (in hours)
- motd
Text String - A message to show users when they connect via FTP or SFTP.
- motd
Use BooleanFor Ftp - Show message to users connecting via FTP
- motd
Use BooleanFor Sftp - Show message to users connecting via SFTP
- name String
- Site name
- next
Billing StringAmount - Next billing amount
- next
Billing StringDate - Next billing date
- non
Sso BooleanGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non
Sso BooleanUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- Boolean
- If true, allows users to use a document editing integration.
- office
Integration StringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- oncehub
Link String - Link to scheduling a meeting with our Sales team
- opt
Out BooleanGlobal - Use servers in the USA only?
- overdue Boolean
- Is this site's billing overdue?
- password
Min IntegerLength - Shortest password length for users
- password
Require BooleanLetter - Require a letter in passwords?
- password
Require BooleanMixed - Require lower and upper case letters in passwords?
- password
Require BooleanNumber - Require a number in passwords?
- password
Require BooleanSpecial - Require special characters in password?
- password
Require BooleanUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password
Requirements BooleanApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password
Validity IntegerDays - Number of days password is valid
- phone String
- Site phone number
- pin
All BooleanRemote Servers To Site Region - 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 BooleanPermissions For Non Site Admins - 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 BooleanGroups Only - 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.
- reply
To StringEmail - Reply-to email for this site
- require2fa Boolean
- Require two-factor authentication for all users?
- require2fa
Exempt BooleanAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa
Stop StringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- require2fa
User StringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require
Logout BooleanFrom Bundles And Inboxes - 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.
- restrict
Root BooleanFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke
Bundle BooleanAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root
Folder BooleanBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session String
- Current session
- session
Expiry IntegerMinutes - Session expiry in minutes
- sftp
Enabled Boolean - Is SFTP enabled?
- sftp
Finalize BooleanPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp
Host StringKey Type - Sftp Host Key Type
- sftp
Insecure BooleanCiphers - 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 BooleanDiffie Hellman - 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
sftpInsecureCiphersoption. - sftp
User BooleanRoot Enabled - Use user FTP roots also for SFTP?
- sharing
Enabled Boolean - Allow bundle creation
- show
Request BooleanAccess Link - Show request access link for users without access? Currently unused.
- show
User BooleanNotifications Log In Link - Show log in link in user notifications?
- String
- Custom site footer text for authenticated pages
- site
Header String - Custom site header text for authenticated pages
- String
- Custom site footer text for public pages
- site
Public StringHeader - 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 Integer - SMTP server port
- smtp
Username String - SMTP server username
- snapshot
Sharing BooleanEnabled - Allow snapshot share links creation
- ssl
Required Boolean - Is SSL required? Disabling this is insecure.
- subdomain String
- Site subdomain
- switch
To StringPlan Date - If switching plans, when does the new plan take effect?
- trial
Days IntegerLeft - Number of days left in trial
- trial
Until String - When does this Site trial expire?
- uploads
Via BooleanEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use
Dedicated BooleanIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use
Provided BooleanModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - user String
- User of current session
- user
Lockout Boolean - Will users be locked out after incorrect login attempts?
- user
Lockout IntegerLock Period - How many hours to lock user out for failed password?
- user
Lockout IntegerTries - Number of login tries within
userLockoutWithinhours before users are locked out - user
Lockout IntegerWithin - Number of hours for user lockout window
- user
Requests BooleanEnabled - Enable User Requests feature
- user
Requests BooleanNotify Admins - Send email to site admins when a user request is received?
- username
Display String - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users
Can BooleanCreate Api Keys - Allow users to create their own API keys?
- users
Can BooleanCreate Ssh Keys - Allow users to create their own SSH keys?
- welcome
Custom StringText - Custom text send in user welcome email
- welcome
Email StringCc - Include this email in welcome emails if enabled
- welcome
Email BooleanEnabled - Will the welcome email be sent to new users?
- welcome
Email StringSubject - Include this email subject in welcome emails if enabled
- welcome
Screen String - Does the welcome screen appear?
- windows
Mode BooleanFtp - Does FTP user Windows emulation mode?
- active
Sftp numberHost Key Id - Id of the currently selected custom SFTP Host Key
- additional
Text string[]File Types - Additional extensions that are considered text files
- admin
User numberId - User ID for the main site administrator
- admins
Bypass booleanLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- ai
Feature anyAvailability - Availability settings for AI features by user class
- allow
Bundle booleanNames - Are manual Bundle names allowed?
- allow
User booleanLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow
User booleanLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow
User booleanLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa
Method booleanBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa
Method booleanEmail - Is OTP via email two factor authentication allowed?
- allowed2fa
Method booleanSms - Is SMS two factor authentication allowed?
- allowed2fa
Method booleanStatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa
Method booleanTotp - Is TOTP two factor authentication allowed?
- allowed2fa
Method booleanWebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa
Method booleanYubi - Is yubikey two factor authentication allowed?
- allowed
Countries string - Comma separated list of allowed Country codes
- allowed
Ips string - List of allowed IP addresses
- always
Mkdir booleanParents - 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.
- as2Message
Retention numberDays - Number of days to retain AS2 messages (incoming and outgoing).
- ask
About booleanOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle
Activity stringNotifications - Do Bundle owners receive activity notifications?
- bundle
Expiration number - Site-wide Bundle expiration in days
- bundle
Not stringFound Message - Custom error message to show when bundle is not found.
- bundle
Password booleanRequired - Do Bundles require password protection?
- bundle
Recipient string[]Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle
Recipient booleanBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle
Registration stringNotifications - Do Bundle owners receive registration notification?
- bundle
Require booleanNote - Do Bundles require internal notes?
- bundle
Require booleanRegistration - Do Bundles require registration?
- boolean
- Do Bundles require recipients for sharing?
- bundle
Send booleanOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- boolean
- Do Bundle creators receive receipts of invitations?
- bundle
Upload stringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle
Watermark stringAttachment - Preview watermark image applied to all bundle items.
- bundle
Watermark anyValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles
Default booleanOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate
File booleanChecksums Crc32 - Calculate CRC32 checksums for files?
- calculate
File booleanChecksums Md5 - Calculate MD5 checksums for files?
- calculate
File booleanChecksums Sha1 - Calculate SHA1 checksums for files?
- calculate
File booleanChecksums Sha256 - Calculate SHA256 checksums for files?
- color2Left string
- Page link and button color
- color2Link string
- Top bar link color
- color2Text string
- Page link and button color
- color2Top string
- Top bar background color
- color2Top
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 boolean - Is this site using a custom namespace for users?
- dav
Enabled boolean - Is WebDAV enabled?
- dav
User booleanRoot Enabled - Use user FTP roots also for WebDAV?
- days
To numberRetain Backups - Number of days to keep deleted files
- default
Time stringZone - Site default time zone
- desktop
App boolean - Is the desktop app enabled?
- desktop
App booleanSession Ip Pinning - Is desktop app session IP pinning enabled?
- desktop
App numberSession Lifetime - Desktop app session lifetime (in hours)
- disable
All booleanAi Features - If true, all AI features are disabled for this site.
- disable
Files booleanCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable
Notifications boolean - Are notifications disabled?
- disable
Password booleanReset - Is password reset disabled?
- disallowed
Countries string - Comma separated list of disallowed Country codes
- document
Edits booleanIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain string
- Custom domain
- domain
Hsts booleanHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain
Letsencrypt stringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email string
- Main email for this site
- string
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp boolean
- Are FedRAMP security restrictions enabled for this site?
- folder
Permissions booleanGroups Only - If true, permissions for this site must be bound to a group (not a user).
- ftp
Enabled boolean - Is FTP enabled?
- group
Admins booleanCan Add Users - Allow group admins to create users in their groups
- group
Admins booleanCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- group
Admins booleanCan Delete Users - Allow group admins to delete users in their groups
- group
Admins booleanCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- group
Admins booleanCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- group
Admins booleanCan Modify Users - Allow group admins to modify users in their groups
- group
Admins booleanCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- group
Admins booleanCan Set User Password - Allow group admins to set password authentication method
- hipaa boolean
- 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 stringSet At - Can files be modified?
- include
Password booleanIn Welcome Email - Include password in emails to new users?
- language string
- Site default language
- ldap
Base stringDn - Base DN for looking up users in LDAP server
- ldap
Domain string - Domain name that will be appended to usernames
- ldap
Enabled boolean - Main LDAP setting: is LDAP enabled?
- ldap
Group stringAction - Should we sync groups from LDAP server?
- ldap
Group stringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap
Group stringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap
Host string - LDAP host
- ldap
Host2 string - LDAP backup host
- ldap
Host3 string - LDAP backup host
- ldap
Port number - LDAP port
- ldap
Secure boolean - Use secure LDAP?
- ldap
Type string - LDAP type
- ldap
User stringAction - Should we sync users from LDAP server?
- ldap
User stringInclude Groups - 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 stringField - LDAP username field
- legacy
Checksums booleanMode - Use legacy checksums mode?
- login
Help stringText - Login help text
- login
Page stringBackground Image - Branded login page background
- logo string
- Branded logo
- managed
Site anySettings - List of site settings managed by the parent site
- max
Prior numberPasswords - Number of prior passwords to disallow
- mcp
Dcr booleanEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate
Remote booleanServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile
App boolean - Is the mobile app enabled?
- mobile
App booleanSession Ip Pinning - Is mobile app session IP pinning enabled?
- mobile
App numberSession Lifetime - Mobile app session lifetime (in hours)
- motd
Text string - A message to show users when they connect via FTP or SFTP.
- motd
Use booleanFor Ftp - Show message to users connecting via FTP
- motd
Use booleanFor Sftp - Show message to users connecting via SFTP
- name string
- Site name
- next
Billing stringAmount - Next billing amount
- next
Billing stringDate - Next billing date
- non
Sso booleanGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non
Sso booleanUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- boolean
- If true, allows users to use a document editing integration.
- office
Integration stringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- oncehub
Link string - Link to scheduling a meeting with our Sales team
- opt
Out booleanGlobal - Use servers in the USA only?
- overdue boolean
- Is this site's billing overdue?
- password
Min numberLength - Shortest password length for users
- password
Require booleanLetter - Require a letter in passwords?
- password
Require booleanMixed - Require lower and upper case letters in passwords?
- password
Require booleanNumber - Require a number in passwords?
- password
Require booleanSpecial - Require special characters in password?
- password
Require booleanUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password
Requirements booleanApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password
Validity numberDays - Number of days password is valid
- phone string
- Site phone number
- pin
All booleanRemote Servers To Site Region - 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 booleanPermissions For Non Site Admins - 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 booleanGroups Only - 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.
- reply
To stringEmail - Reply-to email for this site
- require2fa boolean
- Require two-factor authentication for all users?
- require2fa
Exempt booleanAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa
Stop stringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- require2fa
User stringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require
Logout booleanFrom Bundles And Inboxes - 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.
- restrict
Root booleanFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke
Bundle booleanAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root
Folder booleanBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session string
- Current session
- session
Expiry numberMinutes - Session expiry in minutes
- sftp
Enabled boolean - Is SFTP enabled?
- sftp
Finalize booleanPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp
Host stringKey Type - Sftp Host Key Type
- sftp
Insecure booleanCiphers - 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 booleanDiffie Hellman - 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
sftpInsecureCiphersoption. - sftp
User booleanRoot Enabled - Use user FTP roots also for SFTP?
- sharing
Enabled boolean - Allow bundle creation
- show
Request booleanAccess Link - Show request access link for users without access? Currently unused.
- show
User booleanNotifications Log In Link - Show log in link in user notifications?
- string
- Custom site footer text for authenticated pages
- site
Header string - Custom site header text for authenticated pages
- string
- Custom site footer text for public pages
- site
Public stringHeader - 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 number - SMTP server port
- smtp
Username string - SMTP server username
- snapshot
Sharing booleanEnabled - Allow snapshot share links creation
- ssl
Required boolean - Is SSL required? Disabling this is insecure.
- subdomain string
- Site subdomain
- switch
To stringPlan Date - If switching plans, when does the new plan take effect?
- trial
Days numberLeft - Number of days left in trial
- trial
Until string - When does this Site trial expire?
- uploads
Via booleanEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use
Dedicated booleanIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use
Provided booleanModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - user string
- User of current session
- user
Lockout boolean - Will users be locked out after incorrect login attempts?
- user
Lockout numberLock Period - How many hours to lock user out for failed password?
- user
Lockout numberTries - Number of login tries within
userLockoutWithinhours before users are locked out - user
Lockout numberWithin - Number of hours for user lockout window
- user
Requests booleanEnabled - Enable User Requests feature
- user
Requests booleanNotify Admins - Send email to site admins when a user request is received?
- username
Display string - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users
Can booleanCreate Api Keys - Allow users to create their own API keys?
- users
Can booleanCreate Ssh Keys - Allow users to create their own SSH keys?
- welcome
Custom stringText - Custom text send in user welcome email
- welcome
Email stringCc - Include this email in welcome emails if enabled
- welcome
Email booleanEnabled - Will the welcome email be sent to new users?
- welcome
Email stringSubject - Include this email subject in welcome emails if enabled
- welcome
Screen string - Does the welcome screen appear?
- windows
Mode booleanFtp - Does FTP user Windows emulation mode?
- active_
sftp_ inthost_ key_ id - Id of the currently selected custom SFTP Host Key
- additional_
text_ Sequence[str]file_ types - Additional extensions that are considered text files
- admin_
user_ intid - User ID for the main site administrator
- admins_
bypass_ boollocked_ subfolders - Allow admins to bypass the locked subfolders setting.
- ai_
feature_ Anyavailability - Availability settings for AI features by user class
- allow_
bundle_ boolnames - Are manual Bundle names allowed?
- allow_
user_ boollevel2fa_ override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow_
user_ boollevel_ allowed_ ip_ override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow_
user_ boollevel_ ssl_ override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa_
method_ boolbypass_ for_ ftp_ sftp_ dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa_
method_ boolemail - Is OTP via email two factor authentication allowed?
- allowed2fa_
method_ boolsms - Is SMS two factor authentication allowed?
- allowed2fa_
method_ boolstatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa_
method_ booltotp - Is TOTP two factor authentication allowed?
- allowed2fa_
method_ boolwebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa_
method_ boolyubi - Is yubikey two factor authentication allowed?
- allowed_
countries str - Comma separated list of allowed Country codes
- allowed_
ips str - List of allowed IP addresses
- always_
mkdir_ boolparents - 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_ intretention_ days - Number of days to retain AS2 messages (incoming and outgoing).
- ask_
about_ booloverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle_
activity_ strnotifications - Do Bundle owners receive activity notifications?
- bundle_
expiration int - Site-wide Bundle expiration in days
- bundle_
not_ strfound_ message - Custom error message to show when bundle is not found.
- bundle_
password_ boolrequired - Do Bundles require password protection?
- bundle_
recipient_ Sequence[str]blacklist_ domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle_
recipient_ boolblacklist_ free_ email_ domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle_
registration_ strnotifications - Do Bundle owners receive registration notification?
- bundle_
require_ boolnote - Do Bundles require internal notes?
- bundle_
require_ boolregistration - Do Bundles require registration?
- bool
- Do Bundles require recipients for sharing?
- bundle_
send_ boolone_ time_ password_ to_ recipient_ at_ registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- bool
- Do Bundle creators receive receipts of invitations?
- bundle_
upload_ strreceipt_ notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle_
watermark_ strattachment - Preview watermark image applied to all bundle items.
- bundle_
watermark_ Anyvalue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles_
default_ boolowned_ by_ primary_ group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate_
file_ boolchecksums_ crc32 - Calculate CRC32 checksums for files?
- calculate_
file_ boolchecksums_ md5 - Calculate MD5 checksums for files?
- calculate_
file_ boolchecksums_ sha1 - Calculate SHA1 checksums for files?
- calculate_
file_ boolchecksums_ sha256 - Calculate SHA256 checksums for files?
- color2_
left str - Page link and button color
- color2_
link str - Top bar link color
- color2_
text str - Page link and button color
- color2_
top str - Top bar background color
- color2_
top_ strtext - Top bar text color
- contact_
name str - Site main contact name
- created_
at str - Time this site was created
- currency str
- Preferred currency
- custom_
namespace bool - Is this site using a custom namespace for users?
- dav_
enabled bool - Is WebDAV enabled?
- dav_
user_ boolroot_ enabled - Use user FTP roots also for WebDAV?
- days_
to_ intretain_ backups - Number of days to keep deleted files
- default_
time_ strzone - Site default time zone
- desktop_
app bool - Is the desktop app enabled?
- desktop_
app_ boolsession_ ip_ pinning - Is desktop app session IP pinning enabled?
- desktop_
app_ intsession_ lifetime - Desktop app session lifetime (in hours)
- disable_
all_ boolai_ features - If true, all AI features are disabled for this site.
- disable_
files_ boolcertificate_ generation - 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_ boolreset - Is password reset disabled?
- disallowed_
countries str - Comma separated list of disallowed Country codes
- document_
edits_ boolin_ bundle_ allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain str
- Custom domain
- domain_
hsts_ boolheader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain_
letsencrypt_ strchain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email str
- Main email for this site
- str
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp bool
- Are FedRAMP security restrictions enabled for this site?
- folder_
permissions_ boolgroups_ only - If true, permissions for this site must be bound to a group (not a user).
- ftp_
enabled bool - Is FTP enabled?
- group_
admins_ boolcan_ add_ users - Allow group admins to create users in their groups
- group_
admins_ boolcan_ bypass_ user_ lifecycle_ rules - Allow group admins to exempt users in their groups from lifecycle rules
- group_
admins_ boolcan_ delete_ users - Allow group admins to delete users in their groups
- group_
admins_ boolcan_ enable_ disable_ users - Allow group admins to enable or disable users in their groups
- group_
admins_ boolcan_ manage_ group_ memberships - Allow group admins to add or remove existing users in their groups
- group_
admins_ boolcan_ modify_ users - Allow group admins to modify users in their groups
- group_
admins_ boolcan_ reset_ passwords - Allow group admins to reset passwords for users in their groups
- group_
admins_ boolcan_ set_ user_ password - Allow group admins to set password authentication method
- hipaa bool
- Is there a signed HIPAA BAA between Files.com and this site?
- icon128 str
- Branded icon 128x128
- icon16 str
- Branded icon 16x16
- icon32 str
- Branded icon 32x32
- icon48 str
- Branded icon 48x48
- immutable_
files_ strset_ at - Can files be modified?
- include_
password_ boolin_ welcome_ email - Include password in emails to new users?
- language str
- Site default language
- ldap_
base_ strdn - Base DN for looking up users in LDAP server
- ldap_
domain str - Domain name that will be appended to usernames
- ldap_
enabled bool - Main LDAP setting: is LDAP enabled?
- ldap_
group_ straction - Should we sync groups from LDAP server?
- ldap_
group_ strexclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap_
group_ strinclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap_
host str - LDAP host
- ldap_
host2 str - LDAP backup host
- ldap_
host3 str - LDAP backup host
- ldap_
port int - LDAP port
- ldap_
secure bool - Use secure LDAP?
- ldap_
type str - LDAP type
- ldap_
user_ straction - Should we sync users from LDAP server?
- ldap_
user_ strinclude_ groups - 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 str - Username for signing in to LDAP server.
- ldap_
username_ strfield - LDAP username field
- legacy_
checksums_ boolmode - Use legacy checksums mode?
- login_
help_ strtext - Login help text
- login_
page_ strbackground_ image - Branded login page background
- logo str
- Branded logo
- managed_
site_ Anysettings - List of site settings managed by the parent site
- max_
prior_ intpasswords - Number of prior passwords to disallow
- mcp_
dcr_ boolenabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate_
remote_ boolserver_ sync_ to_ sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile_
app bool - Is the mobile app enabled?
- mobile_
app_ boolsession_ ip_ pinning - Is mobile app session IP pinning enabled?
- mobile_
app_ intsession_ lifetime - Mobile app session lifetime (in hours)
- motd_
text str - A message to show users when they connect via FTP or SFTP.
- motd_
use_ boolfor_ ftp - Show message to users connecting via FTP
- motd_
use_ boolfor_ sftp - Show message to users connecting via SFTP
- name str
- Site name
- next_
billing_ stramount - Next billing amount
- next_
billing_ strdate - Next billing date
- non_
sso_ boolgroups_ allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non_
sso_ boolusers_ allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- office_
integration_ boolavailable - If true, allows users to use a document editing integration.
- office_
integration_ strtype - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- oncehub_
link str - Link to scheduling a meeting with our Sales team
- opt_
out_ boolglobal - Use servers in the USA only?
- overdue bool
- Is this site's billing overdue?
- password_
min_ intlength - Shortest password length for users
- password_
require_ boolletter - Require a letter in passwords?
- password_
require_ boolmixed - Require lower and upper case letters in passwords?
- password_
require_ boolnumber - Require a number in passwords?
- password_
require_ boolspecial - Require special characters in password?
- password_
require_ boolunbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password_
requirements_ boolapply_ to_ bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password_
validity_ intdays - Number of days password is valid
- phone str
- Site phone number
- pin_
all_ boolremote_ servers_ to_ site_ region - 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_ boolpermissions_ for_ non_ site_ admins - 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_ boolgroups_ only - 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.
- reply_
to_ stremail - Reply-to email for this site
- require2fa bool
- Require two-factor authentication for all users?
- require2fa_
exempt_ boolall_ sso_ users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa_
stop_ strtime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- require2fa_
user_ strtype - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require_
logout_ boolfrom_ bundles_ and_ inboxes - 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.
- restrict_
root_ boolfolder_ behaviors_ to_ site_ admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke_
bundle_ boolaccess_ on_ disable_ or_ delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root_
folder_ boolbehaviors_ apply_ to_ workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session str
- Current session
- session_
expiry_ intminutes - Session expiry in minutes
- sftp_
enabled bool - Is SFTP enabled?
- sftp_
finalize_ boolpartial_ uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp_
host_ strkey_ type - Sftp Host Key Type
- sftp_
insecure_ boolciphers - 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_ booldiffie_ hellman - 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
sftpInsecureCiphersoption. - sftp_
user_ boolroot_ enabled - Use user FTP roots also for SFTP?
- sharing_
enabled bool - Allow bundle creation
- show_
request_ boolaccess_ link - Show request access link for users without access? Currently unused.
- show_
user_ boolnotifications_ log_ in_ link - Show log in link in user notifications?
- str
- Custom site footer text for authenticated pages
- site_
header str - Custom site header text for authenticated pages
- str
- Custom site footer text for public pages
- site_
public_ strheader - Custom site header text for public pages
- smtp_
address str - SMTP server hostname or IP
- smtp_
authentication str - SMTP server authentication type
- smtp_
from str - From address to use when mailing through custom SMTP
- smtp_
port int - SMTP server port
- smtp_
username str - SMTP server username
- snapshot_
sharing_ boolenabled - Allow snapshot share links creation
- ssl_
required bool - Is SSL required? Disabling this is insecure.
- subdomain str
- Site subdomain
- switch_
to_ strplan_ date - If switching plans, when does the new plan take effect?
- trial_
days_ intleft - Number of days left in trial
- trial_
until str - When does this Site trial expire?
- uploads_
via_ boolemail_ authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use_
dedicated_ boolips_ for_ smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use_
provided_ boolmodified_ at - Allow uploaders to set
providedModifiedAtfor uploaded files? - user str
- User of current session
- user_
lockout bool - Will users be locked out after incorrect login attempts?
- user_
lockout_ intlock_ period - How many hours to lock user out for failed password?
- user_
lockout_ inttries - Number of login tries within
userLockoutWithinhours before users are locked out - user_
lockout_ intwithin - Number of hours for user lockout window
- user_
requests_ boolenabled - Enable User Requests feature
- user_
requests_ boolnotify_ admins - Send email to site admins when a user request is received?
- username_
display str - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users_
can_ boolcreate_ api_ keys - Allow users to create their own API keys?
- users_
can_ boolcreate_ ssh_ keys - Allow users to create their own SSH keys?
- welcome_
custom_ strtext - Custom text send in user welcome email
- welcome_
email_ strcc - Include this email in welcome emails if enabled
- welcome_
email_ boolenabled - Will the welcome email be sent to new users?
- welcome_
email_ strsubject - Include this email subject in welcome emails if enabled
- welcome_
screen str - Does the welcome screen appear?
- windows_
mode_ boolftp - Does FTP user Windows emulation mode?
- active
Sftp NumberHost Key Id - Id of the currently selected custom SFTP Host Key
- additional
Text List<String>File Types - Additional extensions that are considered text files
- admin
User NumberId - User ID for the main site administrator
- admins
Bypass BooleanLocked Subfolders - Allow admins to bypass the locked subfolders setting.
- ai
Feature AnyAvailability - Availability settings for AI features by user class
- allow
Bundle BooleanNames - Are manual Bundle names allowed?
- allow
User BooleanLevel2fa Override - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- allow
User BooleanLevel Allowed Ip Override - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- allow
User BooleanLevel Ssl Override - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- allowed2fa
Method BooleanBypass For Ftp Sftp Dav - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- allowed2fa
Method BooleanEmail - Is OTP via email two factor authentication allowed?
- allowed2fa
Method BooleanSms - Is SMS two factor authentication allowed?
- allowed2fa
Method BooleanStatic - Is OTP via static codes for two factor authentication allowed?
- allowed2fa
Method BooleanTotp - Is TOTP two factor authentication allowed?
- allowed2fa
Method BooleanWebauthn - Is WebAuthn two factor authentication allowed?
- allowed2fa
Method BooleanYubi - Is yubikey two factor authentication allowed?
- allowed
Countries String - Comma separated list of allowed Country codes
- allowed
Ips String - List of allowed IP addresses
- always
Mkdir BooleanParents - 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.
- as2Message
Retention NumberDays - Number of days to retain AS2 messages (incoming and outgoing).
- ask
About BooleanOverwrites - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- bundle
Activity StringNotifications - Do Bundle owners receive activity notifications?
- bundle
Expiration Number - Site-wide Bundle expiration in days
- bundle
Not StringFound Message - Custom error message to show when bundle is not found.
- bundle
Password BooleanRequired - Do Bundles require password protection?
- bundle
Recipient List<String>Blacklist Domains - List of email domains to disallow when entering a Bundle/Inbox recipients
- bundle
Recipient BooleanBlacklist Free Email Domains - Disallow free email domains for Bundle/Inbox recipients?
- bundle
Registration StringNotifications - Do Bundle owners receive registration notification?
- bundle
Require BooleanNote - Do Bundles require internal notes?
- bundle
Require BooleanRegistration - Do Bundles require registration?
- Boolean
- Do Bundles require recipients for sharing?
- bundle
Send BooleanOne Time Password To Recipient At Registration - If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
- Boolean
- Do Bundle creators receive receipts of invitations?
- bundle
Upload StringReceipt Notifications - Do Bundle uploaders receive upload confirmation notifications?
- bundle
Watermark StringAttachment - Preview watermark image applied to all bundle items.
- bundle
Watermark AnyValue - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
- bundles
Default BooleanOwned By Primary Group - If true, new Share Links created by a user with a primary group will default to that group as owner.
- calculate
File BooleanChecksums Crc32 - Calculate CRC32 checksums for files?
- calculate
File BooleanChecksums Md5 - Calculate MD5 checksums for files?
- calculate
File BooleanChecksums Sha1 - Calculate SHA1 checksums for files?
- calculate
File BooleanChecksums Sha256 - Calculate SHA256 checksums for files?
- color2Left String
- Page link and button color
- color2Link String
- Top bar link color
- color2Text String
- Page link and button color
- color2Top String
- Top bar background color
- color2Top
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 Boolean - Is this site using a custom namespace for users?
- dav
Enabled Boolean - Is WebDAV enabled?
- dav
User BooleanRoot Enabled - Use user FTP roots also for WebDAV?
- days
To NumberRetain Backups - Number of days to keep deleted files
- default
Time StringZone - Site default time zone
- desktop
App Boolean - Is the desktop app enabled?
- desktop
App BooleanSession Ip Pinning - Is desktop app session IP pinning enabled?
- desktop
App NumberSession Lifetime - Desktop app session lifetime (in hours)
- disable
All BooleanAi Features - If true, all AI features are disabled for this site.
- disable
Files BooleanCertificate Generation - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- disable
Notifications Boolean - Are notifications disabled?
- disable
Password BooleanReset - Is password reset disabled?
- disallowed
Countries String - Comma separated list of disallowed Country codes
- document
Edits BooleanIn Bundle Allowed - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- domain String
- Custom domain
- domain
Hsts BooleanHeader - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- domain
Letsencrypt StringChain - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- email String
- Main email for this site
- String
- Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- fedramp Boolean
- Are FedRAMP security restrictions enabled for this site?
- folder
Permissions BooleanGroups Only - If true, permissions for this site must be bound to a group (not a user).
- ftp
Enabled Boolean - Is FTP enabled?
- group
Admins BooleanCan Add Users - Allow group admins to create users in their groups
- group
Admins BooleanCan Bypass User Lifecycle Rules - Allow group admins to exempt users in their groups from lifecycle rules
- group
Admins BooleanCan Delete Users - Allow group admins to delete users in their groups
- group
Admins BooleanCan Enable Disable Users - Allow group admins to enable or disable users in their groups
- group
Admins BooleanCan Manage Group Memberships - Allow group admins to add or remove existing users in their groups
- group
Admins BooleanCan Modify Users - Allow group admins to modify users in their groups
- group
Admins BooleanCan Reset Passwords - Allow group admins to reset passwords for users in their groups
- group
Admins BooleanCan Set User Password - Allow group admins to set password authentication method
- hipaa Boolean
- 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 StringSet At - Can files be modified?
- include
Password BooleanIn Welcome Email - Include password in emails to new users?
- language String
- Site default language
- ldap
Base StringDn - Base DN for looking up users in LDAP server
- ldap
Domain String - Domain name that will be appended to usernames
- ldap
Enabled Boolean - Main LDAP setting: is LDAP enabled?
- ldap
Group StringAction - Should we sync groups from LDAP server?
- ldap
Group StringExclusion - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
- ldap
Group StringInclusion - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
- ldap
Host String - LDAP host
- ldap
Host2 String - LDAP backup host
- ldap
Host3 String - LDAP backup host
- ldap
Port Number - LDAP port
- ldap
Secure Boolean - Use secure LDAP?
- ldap
Type String - LDAP type
- ldap
User StringAction - Should we sync users from LDAP server?
- ldap
User StringInclude Groups - 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 StringField - LDAP username field
- legacy
Checksums BooleanMode - Use legacy checksums mode?
- login
Help StringText - Login help text
- login
Page StringBackground Image - Branded login page background
- logo String
- Branded logo
- managed
Site AnySettings - List of site settings managed by the parent site
- max
Prior NumberPasswords - Number of prior passwords to disallow
- mcp
Dcr BooleanEnabled - Is OAuth DCR (dynamic client registration) for MCP enabled?
- migrate
Remote BooleanServer Sync To Sync - If true, we will migrate all remote server syncs to the new Sync model.
- mobile
App Boolean - Is the mobile app enabled?
- mobile
App BooleanSession Ip Pinning - Is mobile app session IP pinning enabled?
- mobile
App NumberSession Lifetime - Mobile app session lifetime (in hours)
- motd
Text String - A message to show users when they connect via FTP or SFTP.
- motd
Use BooleanFor Ftp - Show message to users connecting via FTP
- motd
Use BooleanFor Sftp - Show message to users connecting via SFTP
- name String
- Site name
- next
Billing StringAmount - Next billing amount
- next
Billing StringDate - Next billing date
- non
Sso BooleanGroups Allowed - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- non
Sso BooleanUsers Allowed - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- Boolean
- If true, allows users to use a document editing integration.
- office
Integration StringType - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- oncehub
Link String - Link to scheduling a meeting with our Sales team
- opt
Out BooleanGlobal - Use servers in the USA only?
- overdue Boolean
- Is this site's billing overdue?
- password
Min NumberLength - Shortest password length for users
- password
Require BooleanLetter - Require a letter in passwords?
- password
Require BooleanMixed - Require lower and upper case letters in passwords?
- password
Require BooleanNumber - Require a number in passwords?
- password
Require BooleanSpecial - Require special characters in password?
- password
Require BooleanUnbreached - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- password
Requirements BooleanApply To Bundles - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- password
Validity NumberDays - Number of days password is valid
- phone String
- Site phone number
- pin
All BooleanRemote Servers To Site Region - 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 BooleanPermissions For Non Site Admins - 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 BooleanGroups Only - 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.
- reply
To StringEmail - Reply-to email for this site
- require2fa Boolean
- Require two-factor authentication for all users?
- require2fa
Exempt BooleanAll Sso Users - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- require2fa
Stop StringTime - If set, requirement for two-factor authentication has been scheduled to end on this date-time.
- require2fa
User StringType - What type of user is required to use two-factor authentication (when require2fa is set to
truefor this site)? - require
Logout BooleanFrom Bundles And Inboxes - 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.
- restrict
Root BooleanFolder Behaviors To Site Admins - If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- revoke
Bundle BooleanAccess On Disable Or Delete - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- root
Folder BooleanBehaviors Apply To Workspaces - If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
- session String
- Current session
- session
Expiry NumberMinutes - Session expiry in minutes
- sftp
Enabled Boolean - Is SFTP enabled?
- sftp
Finalize BooleanPartial Uploads - Finalize partial SFTP uploads from interrupted connections? Default: true.
- sftp
Host StringKey Type - Sftp Host Key Type
- sftp
Insecure BooleanCiphers - 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 BooleanDiffie Hellman - 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
sftpInsecureCiphersoption. - sftp
User BooleanRoot Enabled - Use user FTP roots also for SFTP?
- sharing
Enabled Boolean - Allow bundle creation
- show
Request BooleanAccess Link - Show request access link for users without access? Currently unused.
- show
User BooleanNotifications Log In Link - Show log in link in user notifications?
- String
- Custom site footer text for authenticated pages
- site
Header String - Custom site header text for authenticated pages
- String
- Custom site footer text for public pages
- site
Public StringHeader - 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 Number - SMTP server port
- smtp
Username String - SMTP server username
- snapshot
Sharing BooleanEnabled - Allow snapshot share links creation
- ssl
Required Boolean - Is SSL required? Disabling this is insecure.
- subdomain String
- Site subdomain
- switch
To StringPlan Date - If switching plans, when does the new plan take effect?
- trial
Days NumberLeft - Number of days left in trial
- trial
Until String - When does this Site trial expire?
- uploads
Via BooleanEmail Authentication - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
- use
Dedicated BooleanIps For Smtp - If using custom SMTP, should we use dedicated IPs to deliver emails?
- use
Provided BooleanModified At - Allow uploaders to set
providedModifiedAtfor uploaded files? - user String
- User of current session
- user
Lockout Boolean - Will users be locked out after incorrect login attempts?
- user
Lockout NumberLock Period - How many hours to lock user out for failed password?
- user
Lockout NumberTries - Number of login tries within
userLockoutWithinhours before users are locked out - user
Lockout NumberWithin - Number of hours for user lockout window
- user
Requests BooleanEnabled - Enable User Requests feature
- user
Requests BooleanNotify Admins - Send email to site admins when a user request is received?
- username
Display String - How usernames are displayed in the web UI. Can be
usernameOnly,fullNameOnly,fullNameUsername,fullNameCompany, orfullNameUsernameCompany. - users
Can BooleanCreate Api Keys - Allow users to create their own API keys?
- users
Can BooleanCreate Ssh Keys - Allow users to create their own SSH keys?
- welcome
Custom StringText - Custom text send in user welcome email
- welcome
Email StringCc - Include this email in welcome emails if enabled
- welcome
Email BooleanEnabled - Will the welcome email be sent to new users?
- welcome
Email StringSubject - Include this email subject in welcome emails if enabled
- welcome
Screen String - Does the welcome screen appear?
- windows
Mode BooleanFtp - Does FTP user Windows emulation mode?
Import
The pulumi import command can be used, for example:
Sites can be imported by specifying any ID.
$ pulumi import filescom:index/site:Site example_site 1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- filescom jschady/pulumi-filescom
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
filescomTerraform Provider.
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
published on Thursday, Aug 20, 2026 by jschady