Site (Files.com Java SDK 1.4.47 API)

java.lang.Object
- com.files.models.Site

All Implemented Interfaces:: ModelInterface

public class Site
extends Object
implements ModelInterface

Field Summary

Fields
Modifier and Type	Field and Description
`Long`	`activeSftpHostKeyId` Id of the currently selected custom SFTP Host Key
`String[]`	`additionalTextFileTypes` Additional extensions that are considered text files
`Boolean`	`adminsBypassLockedSubfolders` Allow admins to bypass the locked subfolders setting.
`Long`	`adminUserId` User ID for the main site administrator
`Boolean`	`allowBundleNames` Are manual Bundle names allowed?
`Boolean`	`allowed2faMethodBypassForFtpSftpDav` Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
`Boolean`	`allowed2faMethodEmail` Is OTP via email two factor authentication allowed?
`Boolean`	`allowed2faMethodSms` Is SMS two factor authentication allowed?
`Boolean`	`allowed2faMethodStatic` Is OTP via static codes for two factor authentication allowed?
`Boolean`	`allowed2faMethodTotp` Is TOTP two factor authentication allowed?
`Boolean`	`allowed2faMethodU2f` Is U2F two factor authentication allowed?
`Boolean`	`allowed2faMethodWebauthn` Is WebAuthn two factor authentication allowed?
`Boolean`	`allowed2faMethodYubi` Is yubikey two factor authentication allowed?
`String`	`allowedCountries` Comma separated list of allowed Country codes
`String`	`allowedIps` List of allowed IP addresses
`Boolean`	`alwaysMkdirParents` Create parent directories if they do not exist during uploads?
`Boolean`	`askAboutOverwrites` If false, rename conflicting files instead of asking for overwrite confirmation.
`String`	`bundleActivityNotifications` Do Bundle owners receive activity notifications?
`Long`	`bundleExpiration` Site-wide Bundle expiration in days
`String`	`bundleNotFoundMessage` Custom error message to show when bundle is not found.
`Boolean`	`bundlePasswordRequired` Do Bundles require password protection?
`String[]`	`bundleRecipientBlacklistDomains` List of email domains to disallow when entering a Bundle/Inbox recipients
`Boolean`	`bundleRecipientBlacklistFreeEmailDomains` Disallow free email domains for Bundle/Inbox recipients?
`String`	`bundleRegistrationNotifications` Do Bundle owners receive registration notification?
`Boolean`	`bundleRequireNote` Do Bundles require internal notes?
`Boolean`	`bundleRequireRegistration` Do Bundles require registration?
`Boolean`	`bundleRequireShareRecipient` Do Bundles require recipients for sharing?
`String`	`bundleUploadReceiptNotifications` Do Bundle uploaders receive upload confirmation notifications?
`Image`	`bundleWatermarkAttachment` Preview watermark image applied to all bundle items.
`Map<String,String>`	`bundleWatermarkValue` Preview watermark settings applied to all bundle items.
`String`	`color2Left` Page link and button color
`String`	`color2Link` Top bar link color
`String`	`color2Text` Page link and button color
`String`	`color2Top` Top bar background color
`String`	`color2TopText` Top bar text color
`String`	`contactName` Site main contact name
`Date`	`createdAt` Time this site was created
`String`	`currency` Preferred currency
`Boolean`	`customNamespace` Is this site using a custom namespace for users?
`Boolean`	`davEnabled` Is WebDAV enabled?
`Boolean`	`davUserRootEnabled` Use user FTP roots also for WebDAV?
`Long`	`daysToRetainBackups` Number of days to keep deleted files
`String`	`defaultTimeZone` Site default time zone
`Boolean`	`desktopApp` Is the desktop app enabled?
`Boolean`	`desktopAppSessionIpPinning` Is desktop app session IP pinning enabled?
`Long`	`desktopAppSessionLifetime` Desktop app session lifetime (in hours)
`Boolean`	`disableFilesCertificateGeneration` If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
`Boolean`	`disableNotifications` Are notifications disabled?
`Boolean`	`disablePasswordReset` Is password reset disabled?
`Long`	`disableUsersFromInactivityPeriodDays` If greater than zero, users will unable to login if they do not show activity within this number of days.
`String`	`disallowedCountries` Comma separated list of disallowed Country codes
`String`	`domain` Custom domain
`Boolean`	`domainHstsHeader` Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
`String`	`domainLetsencryptChain` Letsencrypt chain to use when registering SSL Certificate for domain.
`String`	`email` Main email for this site
`Boolean`	`folderPermissionsGroupsOnly` If true, permissions for this site must be bound to a group (not a user).
`Boolean`	`ftpEnabled` Is FTP enabled?
`Boolean`	`groupAdminsCanSetUserPassword` Allow group admins set password authentication method
`Boolean`	`hipaa` Is there a signed HIPAA BAA between Files.com and this site?
`Image`	`icon128` Branded icon 128x128
`Image`	`icon16` Branded icon 16x16
`Image`	`icon32` Branded icon 32x32
`Image`	`icon48` Branded icon 48x48
`Long`	`id` Site Id
`Date`	`immutableFilesSetAt` Can files be modified?
`Boolean`	`includePasswordInWelcomeEmail` Include password in emails to new users?
`String`	`language` Site default language
`String`	`ldapBaseDn` Base DN for looking up users in LDAP server
`String`	`ldapDomain` Domain name that will be appended to usernames
`Boolean`	`ldapEnabled` Main LDAP setting: is LDAP enabled?
`String`	`ldapGroupAction` Should we sync groups from LDAP server?
`String`	`ldapGroupExclusion` Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
`String`	`ldapGroupInclusion` Comma or newline separated list of group names (with optional wildcards) to include when syncing.
`String`	`ldapHost` LDAP host
`String`	`ldapHost2` LDAP backup host
`String`	`ldapHost3` LDAP backup host
`Long`	`ldapPort` LDAP port
`Boolean`	`ldapSecure` Use secure LDAP?
`String`	`ldapType` LDAP type
`String`	`ldapUserAction` Should we sync users from LDAP server?
`String`	`ldapUserIncludeGroups` Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
`String`	`ldapUsername` Username for signing in to LDAP server.
`String`	`ldapUsernameField` LDAP username field
`String`	`loginHelpText` Login help text
`Image`	`loginPageBackgroundImage` Branded login page background
`Image`	`logo` Branded logo
`Long`	`maxPriorPasswords` Number of prior passwords to disallow
`Boolean`	`mobileApp` Is the mobile app enabled?
`Boolean`	`mobileAppSessionIpPinning` Is mobile app session IP pinning enabled?
`Long`	`mobileAppSessionLifetime` Mobile app session lifetime (in hours)
`String`	`motdText` A message to show users when they connect via FTP or SFTP.
`Boolean`	`motdUseForFtp` Show message to users connecting via FTP
`Boolean`	`motdUseForSftp` Show message to users connecting via SFTP
`String`	`name` Site name
`Double`	`nextBillingAmount` Next billing amount
`String`	`nextBillingDate` Next billing date
`Boolean`	`nonSsoGroupsAllowed` If true, groups can be manually created / modified / deleted by Site Admins.
`Boolean`	`nonSsoUsersAllowed` If true, users can be manually created / modified / deleted by Site Admins.
`Boolean`	`officeIntegrationAvailable` Allow users to use Office for the web?
`String`	`officeIntegrationType` Office integration application used to edit and view the MS Office documents
`String`	`oncehubLink` Link to scheduling a meeting with our Sales team
`Boolean`	`optOutGlobal` Use servers in the USA only?
`Boolean`	`overdue` Is this site's billing overdue?
`Long`	`passwordMinLength` Shortest password length for users
`Boolean`	`passwordRequireLetter` Require a letter in passwords?
`Boolean`	`passwordRequirementsApplyToBundles` Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
`Boolean`	`passwordRequireMixed` Require lower and upper case letters in passwords?
`Boolean`	`passwordRequireNumber` Require a number in passwords?
`Boolean`	`passwordRequireSpecial` Require special characters in password?
`Boolean`	`passwordRequireUnbreached` Require passwords that have not been previously breached?
`Long`	`passwordValidityDays` Number of days password is valid
`String`	`phone` Site phone number
`Boolean`	`pinAllRemoteServersToSiteRegion` If true, we will ensure that all internal communications with any remote server are made through the primary region of the site.
`Boolean`	`preventRootPermissionsForNonSiteAdmins` If true, we will prevent non-administrators from receiving any permissions directly on the root folder.
`Boolean`	`protocolAccessGroupsOnly` If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.
`String`	`replyToEmail` Reply-to email for this site
`Boolean`	`require2fa` Require two-factor authentication for all users?
`Date`	`require2faStopTime` If set, requirement for two-factor authentication has been scheduled to end on this date-time.
`String`	`require2faUserType` What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
`Boolean`	`requireLogoutFromBundlesAndInboxes` If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
`Session`	`session` Current session
`Double`	`sessionExpiry` Session expiry in hours
`Long`	`sessionExpiryMinutes` Session expiry in minutes
`Boolean`	`sessionPinnedByIp` Are sessions locked to the same IP?
`Boolean`	`sftpEnabled` Is SFTP enabled?
`String`	`sftpHostKeyType` Sftp Host Key Type
`Boolean`	`sftpInsecureCiphers` If true, we will allow weak and known insecure ciphers to be used for SFTP connections.
`Boolean`	`sftpInsecureDiffieHellman` If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list.
`Boolean`	`sftpUserRootEnabled` Use user FTP roots also for SFTP?
`Boolean`	`sharingEnabled` Allow bundle creation
`Boolean`	`showRequestAccessLink` Show request access link for users without access?
`String`	`siteFooter` Custom site footer text
`String`	`siteHeader` Custom site header text
`String`	`smtpAddress` SMTP server hostname or IP
`String`	`smtpAuthentication` SMTP server authentication type
`String`	`smtpFrom` From address to use when mailing through custom SMTP
`Long`	`smtpPort` SMTP server port
`String`	`smtpUsername` SMTP server username
`Boolean`	`sslRequired` Is SSL required?
`String`	`subdomain` Site subdomain
`Date`	`switchToPlanDate` If switching plans, when does the new plan take effect?
`Boolean`	`tlsDisabled` DO NOT ENABLE.
`Long`	`trialDaysLeft` Number of days left in trial
`Date`	`trialUntil` When does this Site trial expire?
`Boolean`	`uploadsViaEmailAuthentication` Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
`Boolean`	`useDedicatedIpsForSmtp` If using custom SMTP, should we use dedicated IPs to deliver emails?
`Boolean`	`useProvidedModifiedAt` Allow uploaders to set `provided_modified_at` for uploaded files?
`User`	`user` User of current session
`Boolean`	`userLockout` Will users be locked out after incorrect login attempts?
`Long`	`userLockoutLockPeriod` How many hours to lock user out for failed password?
`Long`	`userLockoutTries` Number of login tries within `user_lockout_within` hours before users are locked out
`Long`	`userLockoutWithin` Number of hours for user lockout window
`Boolean`	`userRequestsEnabled` Enable User Requests feature
`Boolean`	`userRequestsNotifyAdmins` Send email to site admins when a user request is received?
`Boolean`	`usersCanCreateApiKeys` Allow users to create their own API keys?
`Boolean`	`usersCanCreateSshKeys` Allow users to create their own SSH keys?
`String`	`welcomeCustomText` Custom text send in user welcome email
`String`	`welcomeEmailCc` Include this email in welcome emails if enabled
`Boolean`	`welcomeEmailEnabled` Will the welcome email be sent to new users?
`String`	`welcomeEmailSubject` Include this email subject in welcome emails if enabled
`String`	`welcomeScreen` Does the welcome screen appear?
`Boolean`	`windowsModeFtp` Does FTP user Windows emulation mode?

Constructor Summary

Constructors
Constructor and Description

Site()

Site(HashMap<String,Object> parameters)

Site(HashMap<String,Object> parameters, HashMap<String,Object> options)

Constructors
Constructor and Description
`Site()`
`Site(HashMap<String,Object> parameters)`
`Site(HashMap<String,Object> parameters, HashMap<String,Object> options)`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Site`	`get(HashMap<String,Object> parameters)`
`static Site`	`get(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static UsageSnapshot`	`getUsage(HashMap<String,Object> parameters)`
`static UsageSnapshot`	`getUsage(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static Site`	`update(HashMap<String,Object> parameters)` Parameters: name - string - Site name subdomain - string - Site subdomain domain - string - Custom domain domain_hsts_header - boolean - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
`static Site`	`update(HashMap<String,Object> parameters, HashMap<String,Object> options)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface
setOptions

- Field Detail
  - id
```
public Long id
```
    Site Id
  - name
```
public String name
```
    Site name
  - additionalTextFileTypes
```
public String[] additionalTextFileTypes
```
    Additional extensions that are considered text files
  - allowed2faMethodSms
```
public Boolean allowed2faMethodSms
```
    Is SMS two factor authentication allowed?
  - allowed2faMethodTotp
```
public Boolean allowed2faMethodTotp
```
    Is TOTP two factor authentication allowed?
  - allowed2faMethodU2f
```
public Boolean allowed2faMethodU2f
```
    Is U2F two factor authentication allowed?
  - allowed2faMethodWebauthn
```
public Boolean allowed2faMethodWebauthn
```
    Is WebAuthn two factor authentication allowed?
  - allowed2faMethodYubi
```
public Boolean allowed2faMethodYubi
```
    Is yubikey two factor authentication allowed?
  - allowed2faMethodEmail
```
public Boolean allowed2faMethodEmail
```
    Is OTP via email two factor authentication allowed?
  - allowed2faMethodStatic
```
public Boolean allowed2faMethodStatic
```
    Is OTP via static codes for two factor authentication allowed?
  - allowed2faMethodBypassForFtpSftpDav
```
public Boolean allowed2faMethodBypassForFtpSftpDav
```
    Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
  - adminUserId
```
public Long adminUserId
```
    User ID for the main site administrator
  - adminsBypassLockedSubfolders
```
public Boolean adminsBypassLockedSubfolders
```
    Allow admins to bypass the locked subfolders setting.
  - allowBundleNames
```
public Boolean allowBundleNames
```
    Are manual Bundle names allowed?
  - allowedCountries
```
public String allowedCountries
```
    Comma separated list of allowed Country codes
  - allowedIps
```
public String allowedIps
```
    List of allowed IP addresses
  - alwaysMkdirParents
```
public Boolean alwaysMkdirParents
```
    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.
  - askAboutOverwrites
```
public Boolean askAboutOverwrites
```
    If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
  - bundleActivityNotifications
```
public String bundleActivityNotifications
```
    Do Bundle owners receive activity notifications?
  - bundleExpiration
```
public Long bundleExpiration
```
    Site-wide Bundle expiration in days
  - bundleNotFoundMessage
```
public String bundleNotFoundMessage
```
    Custom error message to show when bundle is not found.
  - bundlePasswordRequired
```
public Boolean bundlePasswordRequired
```
    Do Bundles require password protection?
  - bundleRecipientBlacklistDomains
```
public String[] bundleRecipientBlacklistDomains
```
    List of email domains to disallow when entering a Bundle/Inbox recipients
  - bundleRecipientBlacklistFreeEmailDomains
```
public Boolean bundleRecipientBlacklistFreeEmailDomains
```
    Disallow free email domains for Bundle/Inbox recipients?
  - bundleRegistrationNotifications
```
public String bundleRegistrationNotifications
```
    Do Bundle owners receive registration notification?
  - bundleRequireRegistration
```
public Boolean bundleRequireRegistration
```
    Do Bundles require registration?
  - bundleRequireShareRecipient
```
public Boolean bundleRequireShareRecipient
```
    Do Bundles require recipients for sharing?
  - bundleRequireNote
```
public Boolean bundleRequireNote
```
    Do Bundles require internal notes?
  - bundleUploadReceiptNotifications
```
public String bundleUploadReceiptNotifications
```
    Do Bundle uploaders receive upload confirmation notifications?
  - bundleWatermarkAttachment
```
public Image bundleWatermarkAttachment
```
    Preview watermark image applied to all bundle items.
  - bundleWatermarkValue
```
public Map<String,String> bundleWatermarkValue
```
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
  - uploadsViaEmailAuthentication
```
public Boolean uploadsViaEmailAuthentication
```
    Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
  - color2Left
```
public String color2Left
```
    Page link and button color
  - color2Link
```
public String color2Link
```
    Top bar link color
  - color2Text
```
public String color2Text
```
    Page link and button color
  - color2Top
```
public String color2Top
```
    Top bar background color
  - color2TopText
```
public String color2TopText
```
    Top bar text color
  - contactName
```
public String contactName
```
    Site main contact name
  - createdAt
```
public Date createdAt
```
    Time this site was created
  - currency
```
public String currency
```
    Preferred currency
  - customNamespace
```
public Boolean customNamespace
```
    Is this site using a custom namespace for users?
  - davEnabled
```
public Boolean davEnabled
```
    Is WebDAV enabled?
  - davUserRootEnabled
```
public Boolean davUserRootEnabled
```
    Use user FTP roots also for WebDAV?
  - daysToRetainBackups
```
public Long daysToRetainBackups
```
    Number of days to keep deleted files
  - defaultTimeZone
```
public String defaultTimeZone
```
    Site default time zone
  - desktopApp
```
public Boolean desktopApp
```
    Is the desktop app enabled?
  - desktopAppSessionIpPinning
```
public Boolean desktopAppSessionIpPinning
```
    Is desktop app session IP pinning enabled?
  - desktopAppSessionLifetime
```
public Long desktopAppSessionLifetime
```
    Desktop app session lifetime (in hours)
  - mobileApp
```
public Boolean mobileApp
```
    Is the mobile app enabled?
  - mobileAppSessionIpPinning
```
public Boolean mobileAppSessionIpPinning
```
    Is mobile app session IP pinning enabled?
  - mobileAppSessionLifetime
```
public Long mobileAppSessionLifetime
```
    Mobile app session lifetime (in hours)
  - disallowedCountries
```
public String disallowedCountries
```
    Comma separated list of disallowed Country codes
  - disableFilesCertificateGeneration
```
public Boolean disableFilesCertificateGeneration
```
    If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
  - disableNotifications
```
public Boolean disableNotifications
```
    Are notifications disabled?
  - disablePasswordReset
```
public Boolean disablePasswordReset
```
    Is password reset disabled?
  - domain
```
public String domain
```
    Custom domain
  - domainHstsHeader
```
public Boolean domainHstsHeader
```
    Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
  - domainLetsencryptChain
```
public String domainLetsencryptChain
```
    Letsencrypt chain to use when registering SSL Certificate for domain.
  - email
```
public String email
```
    Main email for this site
  - ftpEnabled
```
public Boolean ftpEnabled
```
    Is FTP enabled?
  - replyToEmail
```
public String replyToEmail
```
    Reply-to email for this site
  - nonSsoGroupsAllowed
```
public Boolean nonSsoGroupsAllowed
```
    If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
  - nonSsoUsersAllowed
```
public Boolean nonSsoUsersAllowed
```
    If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
  - folderPermissionsGroupsOnly
```
public Boolean folderPermissionsGroupsOnly
```
    If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
  - hipaa
```
public Boolean hipaa
```
    Is there a signed HIPAA BAA between Files.com and this site?
  - icon128
```
public Image icon128
```
    Branded icon 128x128
  - icon16
```
public Image icon16
```
    Branded icon 16x16
  - icon32
```
public Image icon32
```
    Branded icon 32x32
  - icon48
```
public Image icon48
```
    Branded icon 48x48
  - immutableFilesSetAt
```
public Date immutableFilesSetAt
```
    Can files be modified?
  - includePasswordInWelcomeEmail
```
public Boolean includePasswordInWelcomeEmail
```
    Include password in emails to new users?
  - language
```
public String language
```
    Site default language
  - ldapBaseDn
```
public String ldapBaseDn
```
    Base DN for looking up users in LDAP server
  - ldapDomain
```
public String ldapDomain
```
    Domain name that will be appended to usernames
  - ldapEnabled
```
public Boolean ldapEnabled
```
    Main LDAP setting: is LDAP enabled?
  - ldapGroupAction
```
public String ldapGroupAction
```
    Should we sync groups from LDAP server?
  - ldapGroupExclusion
```
public String ldapGroupExclusion
```
    Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
  - ldapGroupInclusion
```
public String ldapGroupInclusion
```
    Comma or newline separated list of group names (with optional wildcards) to include when syncing.
  - ldapHost
```
public String ldapHost
```
    LDAP host
  - ldapHost2
```
public String ldapHost2
```
    LDAP backup host
  - ldapHost3
```
public String ldapHost3
```
    LDAP backup host
  - ldapPort
```
public Long ldapPort
```
    LDAP port
  - ldapSecure
```
public Boolean ldapSecure
```
    Use secure LDAP?
  - ldapType
```
public String ldapType
```
    LDAP type
  - ldapUserAction
```
public String ldapUserAction
```
    Should we sync users from LDAP server?
  - ldapUserIncludeGroups
```
public String ldapUserIncludeGroups
```
    Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
  - ldapUsername
```
public String ldapUsername
```
    Username for signing in to LDAP server.
  - ldapUsernameField
```
public String ldapUsernameField
```
    LDAP username field
  - loginHelpText
```
public String loginHelpText
```
    Login help text
  - logo
```
public Image logo
```
    Branded logo
  - loginPageBackgroundImage
```
public Image loginPageBackgroundImage
```
    Branded login page background
  - maxPriorPasswords
```
public Long maxPriorPasswords
```
    Number of prior passwords to disallow
  - motdText
```
public String motdText
```
    A message to show users when they connect via FTP or SFTP.
  - motdUseForFtp
```
public Boolean motdUseForFtp
```
    Show message to users connecting via FTP
  - motdUseForSftp
```
public Boolean motdUseForSftp
```
    Show message to users connecting via SFTP
  - nextBillingAmount
```
public Double nextBillingAmount
```
    Next billing amount
  - nextBillingDate
```
public String nextBillingDate
```
    Next billing date
  - officeIntegrationAvailable
```
public Boolean officeIntegrationAvailable
```
    Allow users to use Office for the web?
  - officeIntegrationType
```
public String officeIntegrationType
```
    Office integration application used to edit and view the MS Office documents
  - oncehubLink
```
public String oncehubLink
```
    Link to scheduling a meeting with our Sales team
  - optOutGlobal
```
public Boolean optOutGlobal
```
    Use servers in the USA only?
  - overdue
```
public Boolean overdue
```
    Is this site's billing overdue?
  - passwordMinLength
```
public Long passwordMinLength
```
    Shortest password length for users
  - passwordRequireLetter
```
public Boolean passwordRequireLetter
```
    Require a letter in passwords?
  - passwordRequireMixed
```
public Boolean passwordRequireMixed
```
    Require lower and upper case letters in passwords?
  - passwordRequireNumber
```
public Boolean passwordRequireNumber
```
    Require a number in passwords?
  - passwordRequireSpecial
```
public Boolean passwordRequireSpecial
```
    Require special characters in password?
  - passwordRequireUnbreached
```
public Boolean passwordRequireUnbreached
```
    Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
  - passwordRequirementsApplyToBundles
```
public Boolean passwordRequirementsApplyToBundles
```
    Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
  - passwordValidityDays
```
public Long passwordValidityDays
```
    Number of days password is valid
  - phone
```
public String phone
```
    Site phone number
  - pinAllRemoteServersToSiteRegion
```
public Boolean pinAllRemoteServersToSiteRegion
```
    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.
  - preventRootPermissionsForNonSiteAdmins
```
public Boolean preventRootPermissionsForNonSiteAdmins
```
    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.
  - protocolAccessGroupsOnly
```
public Boolean protocolAccessGroupsOnly
```
    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.
  - require2fa
```
public Boolean require2fa
```
    Require two-factor authentication for all users?
  - require2faStopTime
```
public Date require2faStopTime
```
    If set, requirement for two-factor authentication has been scheduled to end on this date-time.
  - require2faUserType
```
public String require2faUserType
```
    What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
  - requireLogoutFromBundlesAndInboxes
```
public Boolean requireLogoutFromBundlesAndInboxes
```
    If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
  - session
```
public Session session
```
    Current session
  - sessionPinnedByIp
```
public Boolean sessionPinnedByIp
```
    Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
  - sftpEnabled
```
public Boolean sftpEnabled
```
    Is SFTP enabled?
  - sftpHostKeyType
```
public String sftpHostKeyType
```
    Sftp Host Key Type
  - activeSftpHostKeyId
```
public Long activeSftpHostKeyId
```
    Id of the currently selected custom SFTP Host Key
  - sftpInsecureCiphers
```
public Boolean sftpInsecureCiphers
```
    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.
  - sftpInsecureDiffieHellman
```
public Boolean sftpInsecureDiffieHellman
```
    If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full `sftp_insecure_ciphers` option.
  - sftpUserRootEnabled
```
public Boolean sftpUserRootEnabled
```
    Use user FTP roots also for SFTP?
  - sharingEnabled
```
public Boolean sharingEnabled
```
    Allow bundle creation
  - showRequestAccessLink
```
public Boolean showRequestAccessLink
```
    Show request access link for users without access? Currently unused.
  - siteFooter
```
public String siteFooter
```
    Custom site footer text
  - siteHeader
```
public String siteHeader
```
    Custom site header text
  - smtpAddress
```
public String smtpAddress
```
    SMTP server hostname or IP
  - smtpAuthentication
```
public String smtpAuthentication
```
    SMTP server authentication type
  - smtpFrom
```
public String smtpFrom
```
    From address to use when mailing through custom SMTP
  - smtpPort
```
public Long smtpPort
```
    SMTP server port
  - smtpUsername
```
public String smtpUsername
```
    SMTP server username
  - sessionExpiry
```
public Double sessionExpiry
```
    Session expiry in hours
  - sessionExpiryMinutes
```
public Long sessionExpiryMinutes
```
    Session expiry in minutes
  - sslRequired
```
public Boolean sslRequired
```
    Is SSL required? Disabling this is insecure.
  - subdomain
```
public String subdomain
```
    Site subdomain
  - switchToPlanDate
```
public Date switchToPlanDate
```
    If switching plans, when does the new plan take effect?
  - tlsDisabled
```
public Boolean tlsDisabled
```
    DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site. We intend to remove this capability entirely in early 2024. If set, the `sftp_insecure_ciphers` flag will be automatically set to true.
  - trialDaysLeft
```
public Long trialDaysLeft
```
    Number of days left in trial
  - trialUntil
```
public Date trialUntil
```
    When does this Site trial expire?
  - useDedicatedIpsForSmtp
```
public Boolean useDedicatedIpsForSmtp
```
    If using custom SMTP, should we use dedicated IPs to deliver emails?
  - useProvidedModifiedAt
```
public Boolean useProvidedModifiedAt
```
    Allow uploaders to set `provided_modified_at` for uploaded files?
  - user
```
public User user
```
    User of current session
  - userLockout
```
public Boolean userLockout
```
    Will users be locked out after incorrect login attempts?
  - userLockoutLockPeriod
```
public Long userLockoutLockPeriod
```
    How many hours to lock user out for failed password?
  - userLockoutTries
```
public Long userLockoutTries
```
    Number of login tries within `user_lockout_within` hours before users are locked out
  - userLockoutWithin
```
public Long userLockoutWithin
```
    Number of hours for user lockout window
  - userRequestsEnabled
```
public Boolean userRequestsEnabled
```
    Enable User Requests feature
  - userRequestsNotifyAdmins
```
public Boolean userRequestsNotifyAdmins
```
    Send email to site admins when a user request is received?
  - usersCanCreateApiKeys
```
public Boolean usersCanCreateApiKeys
```
    Allow users to create their own API keys?
  - usersCanCreateSshKeys
```
public Boolean usersCanCreateSshKeys
```
    Allow users to create their own SSH keys?
  - welcomeCustomText
```
public String welcomeCustomText
```
    Custom text send in user welcome email
  - welcomeEmailCc
```
public String welcomeEmailCc
```
    Include this email in welcome emails if enabled
  - welcomeEmailSubject
```
public String welcomeEmailSubject
```
    Include this email subject in welcome emails if enabled
  - welcomeEmailEnabled
```
public Boolean welcomeEmailEnabled
```
    Will the welcome email be sent to new users?
  - welcomeScreen
```
public String welcomeScreen
```
    Does the welcome screen appear?
  - windowsModeFtp
```
public Boolean windowsModeFtp
```
    Does FTP user Windows emulation mode?
  - disableUsersFromInactivityPeriodDays
```
public Long disableUsersFromInactivityPeriodDays
```
    If greater than zero, users will unable to login if they do not show activity within this number of days.
  - groupAdminsCanSetUserPassword
```
public Boolean groupAdminsCanSetUserPassword
```
    Allow group admins set password authentication method
- Constructor Detail
  - Site
```
public Site()
```
  - Site
```
public Site(HashMap<String,Object> parameters)
```
  - Site
```
public Site(HashMap<String,Object> parameters,
            HashMap<String,Object> options)
```
- Method Detail
  - get
```
public static Site get(HashMap<String,Object> parameters)
                throws RuntimeException
```
    Throws:
    
    RuntimeException
  - get
```
public static Site get(HashMap<String,Object> parameters,
                       HashMap<String,Object> options)
                throws RuntimeException
```
    Throws:
    
    RuntimeException
  - getUsage
```
public static UsageSnapshot getUsage(HashMap<String,Object> parameters)
                              throws RuntimeException
```
    Throws:
    
    RuntimeException
  - getUsage
```
public static UsageSnapshot getUsage(HashMap<String,Object> parameters,
                                     HashMap<String,Object> options)
                              throws RuntimeException
```
    Throws:
    
    RuntimeException
  - update
```
public static Site update(HashMap<String,Object> parameters)
                   throws RuntimeException
```
    Parameters: name - string - Site name subdomain - string - Site subdomain domain - string - Custom domain domain_hsts_header - boolean - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain? domain_letsencrypt_chain - string - Letsencrypt chain to use when registering SSL Certificate for domain. email - string - Main email for this site reply_to_email - string - Reply-to email for this site allow_bundle_names - boolean - Are manual Bundle names allowed? bundle_expiration - int64 - Site-wide Bundle expiration in days welcome_email_enabled - boolean - Will the welcome email be sent to new users? ask_about_overwrites - boolean - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface. show_request_access_link - boolean - Show request access link for users without access? Currently unused. always_mkdir_parents - boolean - Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step. welcome_email_cc - string - Include this email in welcome emails if enabled welcome_email_subject - string - Include this email subject in welcome emails if enabled welcome_custom_text - string - Custom text send in user welcome email language - string - Site default language windows_mode_ftp - boolean - Does FTP user Windows emulation mode? default_time_zone - string - Site default time zone desktop_app - boolean - Is the desktop app enabled? desktop_app_session_ip_pinning - boolean - Is desktop app session IP pinning enabled? desktop_app_session_lifetime - int64 - Desktop app session lifetime (in hours) mobile_app - boolean - Is the mobile app enabled? mobile_app_session_ip_pinning - boolean - Is mobile app session IP pinning enabled? mobile_app_session_lifetime - int64 - Mobile app session lifetime (in hours) folder_permissions_groups_only - boolean - If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user. welcome_screen - string - Does the welcome screen appear? office_integration_available - boolean - Allow users to use Office for the web? office_integration_type - string - Office integration application used to edit and view the MS Office documents pin_all_remote_servers_to_site_region - boolean - If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings. motd_text - string - A message to show users when they connect via FTP or SFTP. motd_use_for_ftp - boolean - Show message to users connecting via FTP motd_use_for_sftp - boolean - Show message to users connecting via SFTP left_navigation_visibility - object - Visibility settings for account navigation additional_text_file_types - array(string) - Additional extensions that are considered text files bundle_require_note - boolean - Do Bundles require internal notes? session_expiry - double - Session expiry in hours ssl_required - boolean - Is SSL required? Disabling this is insecure. tls_disabled - boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site. We intend to remove this capability entirely in early 2024. If set, the `sftp_insecure_ciphers` flag will be automatically set to true. sftp_insecure_ciphers - boolean - If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility. sftp_insecure_diffie_hellman - boolean - If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full `sftp_insecure_ciphers` option. disable_files_certificate_generation - boolean - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain. user_lockout - boolean - Will users be locked out after incorrect login attempts? user_lockout_tries - int64 - Number of login tries within `user_lockout_within` hours before users are locked out user_lockout_within - int64 - Number of hours for user lockout window user_lockout_lock_period - int64 - How many hours to lock user out for failed password? include_password_in_welcome_email - boolean - Include password in emails to new users? allowed_countries - string - Comma separated list of allowed Country codes allowed_ips - string - List of allowed IP addresses disallowed_countries - string - Comma separated list of disallowed Country codes days_to_retain_backups - int64 - Number of days to keep deleted files max_prior_passwords - int64 - Number of prior passwords to disallow password_validity_days - int64 - Number of days password is valid password_min_length - int64 - Shortest password length for users password_require_letter - boolean - Require a letter in passwords? password_require_mixed - boolean - Require lower and upper case letters in passwords? password_require_special - boolean - Require special characters in password? password_require_number - boolean - Require a number in passwords? password_require_unbreached - boolean - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/) require_logout_from_bundles_and_inboxes - boolean - If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page. dav_user_root_enabled - boolean - Use user FTP roots also for WebDAV? sftp_user_root_enabled - boolean - Use user FTP roots also for SFTP? disable_password_reset - boolean - Is password reset disabled? immutable_files - boolean - Are files protected from modification? session_pinned_by_ip - boolean - Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?) bundle_not_found_message - string - Custom error message to show when bundle is not found. bundle_password_required - boolean - Do Bundles require password protection? bundle_require_registration - boolean - Do Bundles require registration? bundle_require_share_recipient - boolean - Do Bundles require recipients for sharing? bundle_registration_notifications - string - Do Bundle owners receive registration notification? bundle_activity_notifications - string - Do Bundle owners receive activity notifications? bundle_upload_receipt_notifications - string - Do Bundle uploaders receive upload confirmation notifications? password_requirements_apply_to_bundles - boolean - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords? prevent_root_permissions_for_non_site_admins - boolean - If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions. opt_out_global - boolean - Use servers in the USA only? use_provided_modified_at - boolean - Allow uploaders to set `provided_modified_at` for uploaded files? custom_namespace - boolean - Is this site using a custom namespace for users? disable_users_from_inactivity_period_days - int64 - If greater than zero, users will unable to login if they do not show activity within this number of days. non_sso_groups_allowed - boolean - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider. non_sso_users_allowed - boolean - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider. sharing_enabled - boolean - Allow bundle creation user_requests_enabled - boolean - Enable User Requests feature user_requests_notify_admins - boolean - Send email to site admins when a user request is received? dav_enabled - boolean - Is WebDAV enabled? ftp_enabled - boolean - Is FTP enabled? sftp_enabled - boolean - Is SFTP enabled? users_can_create_api_keys - boolean - Allow users to create their own API keys? users_can_create_ssh_keys - boolean - Allow users to create their own SSH keys? sftp_host_key_type - string - Sftp Host Key Type active_sftp_host_key_id - int64 - Id of the currently selected custom SFTP Host Key protocol_access_groups_only - boolean - If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site. bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value group_admins_can_set_user_password - boolean - Allow group admins set password authentication method bundle_recipient_blacklist_free_email_domains - boolean - Disallow free email domains for Bundle/Inbox recipients? bundle_recipient_blacklist_domains - array(string) - List of email domains to disallow when entering a Bundle/Inbox recipients admins_bypass_locked_subfolders - boolean - Allow admins to bypass the locked subfolders setting. allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed? allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed? allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed? allowed_2fa_method_webauthn - boolean - Is WebAuthn two factor authentication allowed? allowed_2fa_method_yubi - boolean - Is yubikey two factor authentication allowed? allowed_2fa_method_email - boolean - Is OTP via email two factor authentication allowed? allowed_2fa_method_static - boolean - Is OTP via static codes for two factor authentication allowed? allowed_2fa_method_bypass_for_ftp_sftp_dav - boolean - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV? require_2fa - boolean - Require two-factor authentication for all users? require_2fa_user_type - string - What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)? color2_top - string - Top bar background color 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_text - string - Top bar text color site_header - string - Custom site header text site_footer - string - Custom site footer text login_help_text - string - Login help text use_dedicated_ips_for_smtp - boolean - If using custom SMTP, should we use dedicated IPs to deliver emails? 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_username - string - SMTP server username smtp_port - int64 - SMTP server port ldap_enabled - boolean - Main LDAP setting: is LDAP enabled? ldap_type - string - LDAP type ldap_host - string - LDAP host ldap_host_2 - string - LDAP backup host ldap_host_3 - string - LDAP backup host ldap_port - int64 - LDAP port ldap_secure - boolean - Use secure LDAP? ldap_username - string - Username for signing in to LDAP server. ldap_username_field - string - LDAP username field ldap_domain - string - Domain name that will be appended to usernames ldap_user_action - string - Should we sync users from LDAP server? ldap_group_action - string - Should we sync groups from LDAP server? ldap_user_include_groups - string - Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced. ldap_group_exclusion - string - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing. ldap_group_inclusion - string - Comma or newline separated list of group names (with optional wildcards) to include when syncing. ldap_base_dn - string - Base DN for looking up users in LDAP server uploads_via_email_authentication - boolean - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC? icon16_file - file icon16_delete - boolean - If true, will delete the file stored in icon16 icon32_file - file icon32_delete - boolean - If true, will delete the file stored in icon32 icon48_file - file icon48_delete - boolean - If true, will delete the file stored in icon48 icon128_file - file icon128_delete - boolean - If true, will delete the file stored in icon128 logo_file - file logo_delete - boolean - If true, will delete the file stored in logo bundle_watermark_attachment_file - file bundle_watermark_attachment_delete - boolean - If true, will delete the file stored in bundle_watermark_attachment login_page_background_image_file - file login_page_background_image_delete - boolean - If true, will delete the file stored in login_page_background_image disable_2fa_with_delay - boolean - If set to true, we will begin the process of disabling 2FA on this site. ldap_password_change - string - New LDAP password. ldap_password_change_confirmation - string - Confirm new LDAP password. smtp_password - string - Password for SMTP server. session_expiry_minutes - int64 - Session expiry in minutes
    
    Throws:
    
    RuntimeException
  - update
```
public static Site update(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException

Class Site

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.files.models.ModelInterface

Field Detail

id

name

additionalTextFileTypes

allowed2faMethodSms

allowed2faMethodTotp

allowed2faMethodU2f

allowed2faMethodWebauthn

allowed2faMethodYubi

allowed2faMethodEmail

allowed2faMethodStatic

allowed2faMethodBypassForFtpSftpDav

adminUserId

adminsBypassLockedSubfolders

allowBundleNames

allowedCountries

allowedIps

alwaysMkdirParents

askAboutOverwrites

bundleActivityNotifications

bundleExpiration

bundleNotFoundMessage

bundlePasswordRequired

bundleRecipientBlacklistDomains

bundleRecipientBlacklistFreeEmailDomains

bundleRegistrationNotifications

bundleRequireRegistration

bundleRequireShareRecipient

bundleRequireNote

bundleUploadReceiptNotifications

bundleWatermarkAttachment

bundleWatermarkValue

uploadsViaEmailAuthentication

color2Left

color2Link

color2Text

color2Top

color2TopText

contactName

createdAt

currency

customNamespace

davEnabled

davUserRootEnabled

daysToRetainBackups

defaultTimeZone

desktopApp

desktopAppSessionIpPinning

desktopAppSessionLifetime

mobileApp

mobileAppSessionIpPinning

mobileAppSessionLifetime

disallowedCountries

disableFilesCertificateGeneration

disableNotifications

disablePasswordReset

domain

domainHstsHeader

domainLetsencryptChain

email

ftpEnabled

replyToEmail

nonSsoGroupsAllowed

nonSsoUsersAllowed

folderPermissionsGroupsOnly

hipaa

icon128

icon16

icon32

icon48

immutableFilesSetAt

includePasswordInWelcomeEmail

language

ldapBaseDn