action files_get_site {
  label: "Show site settings"
  description: "Show site settings"
  provider: files
  method: GET
  path: "/site"
  encoding: json
  output: {
    type: "object"
    description: "Show site settings"
    properties: {
      active_sftp_host_key_id: {
        type: "integer"
        format: "int32"
        description: "Id of the currently selected custom SFTP Host Key"
      }
      admin_user_id: {
        type: "integer"
        format: "int32"
        description: "User ID for the main site administrator"
      }
      allow_bundle_names: {
        type: "boolean"
        description: "Are manual Bundle names allowed?"
      }
      allowed_2fa_method_bypass_for_ftp_sftp_dav: {
        type: "boolean"
        description: "Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?"
      }
      allowed_2fa_method_sms: {
        type: "boolean"
        description: "Is SMS two factor authentication allowed?"
      }
      allowed_2fa_method_totp: {
        type: "boolean"
        description: "Is TOTP two factor authentication allowed?"
      }
      allowed_2fa_method_u2f: {
        type: "boolean"
        description: "Is U2F two factor authentication allowed?"
      }
      allowed_2fa_method_webauthn: {
        type: "boolean"
        description: "Is WebAuthn two factor authentication allowed?"
      }
      allowed_2fa_method_yubi: {
        type: "boolean"
        description: "Is yubikey two factor authentication allowed?"
      }
      allowed_countries: {
        type: "string"
        description: "Comma seperated list of allowed Country codes"
      }
      allowed_ips: {
        type: "string"
        description: "List of allowed IP addresses"
      }
      ask_about_overwrites: {
        type: "boolean"
        description: "If false, rename conflicting files instead of asking for overwrite confirmation.  Only applies to web interface."
      }
      bundle_activity_notifications: {
        type: "string"
        description: "Do Bundle owners receive activity notifications?"
        enum: ["never", "always", "per_bundle_setting"]
      }
      bundle_expiration: {
        type: "integer"
        format: "int32"
        description: "Site-wide Bundle expiration in days"
      }
      bundle_password_required: {
        type: "boolean"
        description: "Do Bundles require password protection?"
      }
      bundle_registration_notifications: {
        type: "string"
        description: "Do Bundle owners receive registration notification?"
        enum: ["never", "always", "per_bundle_setting"]
      }
      bundle_require_share_recipient: {
        type: "boolean"
        description: "Do Bundles require recipients for sharing?"
      }
      bundle_upload_receipt_notifications: {
        type: "string"
        description: "Do Bundle uploaders receive upload confirmation notifications?"
        enum: ["never", "always", "per_bundle_setting"]
      }
      bundle_watermark_attachment: {
        type: "object"
        properties: {
          name: {
            type: "string"
            description: "Image name"
          }
          uri: {
            type: "string"
            description: "Image URI"
          }
        }
      }
      bundle_watermark_value: {
        type: "object"
        description: "Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value"
      }
      color2_left: {
        type: "string"
        description: "Page link and button color"
      }
      color2_link: {
        type: "string"
        description: "Top bar link color"
      }
      color2_text: {
        type: "string"
        description: "Page link and button color"
      }
      color2_top: {
        type: "string"
        description: "Top bar background color"
      }
      color2_top_text: {
        type: "string"
        description: "Top bar text color"
      }
      contact_name: {
        type: "string"
        description: "Site main contact name"
      }
      created_at: {
        type: "string"
        format: "date-time"
        description: "Time this site was created"
      }
      currency: {
        type: "string"
        description: "Preferred currency"
      }
      custom_namespace: {
        type: "boolean"
        description: "Is this site using a custom namespace for users?"
      }
      days_to_retain_backups: {
        type: "integer"
        format: "int32"
        description: "Number of days to keep deleted files"
      }
      default_time_zone: {
        type: "string"
        description: "Site default time zone"
      }
      desktop_app: {
        type: "boolean"
        description: "Is the desktop app enabled?"
      }
      desktop_app_session_ip_pinning: {
        type: "boolean"
        description: "Is desktop app session IP pinning enabled?"
      }
      desktop_app_session_lifetime: {
        type: "integer"
        format: "int32"
        description: "Desktop app session lifetime (in hours)"
      }
      disable_files_certificate_generation: {
        type: "boolean"
        description: "If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain."
      }
      disable_notifications: {
        type: "boolean"
        description: "Are notifications disabled?"
      }
      disable_password_reset: {
        type: "boolean"
        description: "Is password reset disabled?"
      }
      disable_users_from_inactivity_period_days: {
        type: "integer"
        format: "int32"
        description: "If greater than zero, users will unable to login if they do not show activity within this number of days."
      }
      disallowed_countries: {
        type: "string"
        description: "Comma seperated list of disallowed Country codes"
      }
      domain: {
        type: "string"
        description: "Custom domain"
      }
      domain_hsts_header: {
        type: "boolean"
        description: "Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?"
      }
      domain_letsencrypt_chain: {
        type: "string"
        description: "Letsencrypt chain to use when registering SSL Certificate for domain."
        enum: ["default", "isrg_root_x1", "dst_root_ca_x3"]
      }
      email: {
        type: "string"
        format: "email"
        description: "Main email for this site"
      }
      folder_permissions_groups_only: {
        type: "boolean"
        description: "If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user."
      }
      ftp_enabled: {
        type: "boolean"
        description: "Is FTP enabled?"
      }
      hipaa: {
        type: "boolean"
        description: "Is there a signed HIPAA BAA between Files.com and this site?"
      }
      icon128: {
        type: "object"
        additionalProperties: true
      }
      icon16: {
        type: "object"
        additionalProperties: true
      }
      icon32: {
        type: "object"
        additionalProperties: true
      }
      icon48: {
        type: "object"
        additionalProperties: true
      }
      immutable_files_set_at: {
        type: "string"
        format: "date-time"
        description: "Can files be modified?"
      }
      include_password_in_welcome_email: {
        type: "boolean"
        description: "Include password in emails to new users?"
      }
      language: {
        type: "string"
        description: "Site default language"
      }
      ldap_base_dn: {
        type: "string"
        description: "Base DN for looking up users in LDAP server"
      }
      ldap_domain: {
        type: "string"
        description: "Domain name that will be appended to usernames"
      }
      ldap_enabled: {
        type: "boolean"
        description: "Main LDAP setting: is LDAP enabled?"
      }
      ldap_group_action: {
        type: "string"
        description: "Should we sync groups from LDAP server?"
      }
      ldap_group_exclusion: {
        type: "string"
        description: "Comma or newline separated list of group names (with optional wildcards) to exclude when syncing."
      }
      ldap_group_inclusion: {
        type: "string"
        description: "Comma or newline separated list of group names (with optional wildcards) to include when syncing."
      }
      ldap_host: {
        type: "string"
        description: "LDAP host"
      }
      ldap_host_2: {
        type: "string"
        description: "LDAP backup host"
      }
      ldap_host_3: {
        type: "string"
        description: "LDAP backup host"
      }
      ldap_port: {
        type: "integer"
        format: "int32"
        description: "LDAP port"
      }
      ldap_secure: {
        type: "boolean"
        description: "Use secure LDAP?"
      }
      ldap_type: {
        type: "string"
        description: "LDAP type"
      }
      ldap_user_action: {
        type: "string"
        description: "Should we sync users from LDAP server?"
      }
      ldap_user_include_groups: {
        type: "string"
        description: "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: {
        type: "string"
        description: "Username for signing in to LDAP server."
      }
      ldap_username_field: {
        type: "string"
        description: "LDAP username field"
      }
      login_help_text: {
        type: "string"
        description: "Login help text"
      }
      logo: {
        type: "object"
        additionalProperties: true
      }
      max_prior_passwords: {
        type: "integer"
        format: "int32"
        description: "Number of prior passwords to disallow"
      }
      mobile_app: {
        type: "boolean"
        description: "Is the mobile app enabled?"
      }
      mobile_app_session_ip_pinning: {
        type: "boolean"
        description: "Is mobile app session IP pinning enabled?"
      }
      mobile_app_session_lifetime: {
        type: "integer"
        format: "int32"
        description: "Mobile app session lifetime (in hours)"
      }
      motd_text: {
        type: "string"
        description: "A message to show users when they connect via FTP or SFTP."
      }
      motd_use_for_ftp: {
        type: "boolean"
        description: "Show message to users connecting via FTP"
      }
      motd_use_for_sftp: {
        type: "boolean"
        description: "Show message to users connecting via SFTP"
      }
      name: {
        type: "string"
        description: "Site name"
      }
      next_billing_amount: {
        type: "number"
        format: "double"
        description: "Next billing amount"
      }
      next_billing_date: {
        type: "string"
        description: "Next billing date"
      }
      non_sso_groups_allowed: {
        type: "boolean"
        description: "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: {
        type: "boolean"
        description: "If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider."
      }
      office_integration_available: {
        type: "boolean"
        description: "Allow users to use Office for the web?"
      }
      office_integration_type: {
        type: "string"
        description: "Office integration application used to edit and view the MS Office documents"
        enum: ["only_office", "office_365", "disabled"]
      }
      oncehub_link: {
        type: "string"
        description: "Link to scheduling a meeting with our Sales team"
      }
      opt_out_global: {
        type: "boolean"
        description: "Use servers in the USA only?"
      }
      overage_notified_at: {
        type: "string"
        format: "date-time"
        description: "Last time the site was notified about an overage"
      }
      overage_notify: {
        type: "boolean"
        description: "Notify site email of overages?"
      }
      overdue: {
        type: "boolean"
        description: "Is this site's billing overdue?"
      }
      password_min_length: {
        type: "integer"
        format: "int32"
        description: "Shortest password length for users"
      }
      password_require_letter: {
        type: "boolean"
        description: "Require a letter in passwords?"
      }
      password_require_mixed: {
        type: "boolean"
        description: "Require lower and upper case letters in passwords?"
      }
      password_require_number: {
        type: "boolean"
        description: "Require a number in passwords?"
      }
      password_require_special: {
        type: "boolean"
        description: "Require special characters in password?"
      }
      password_require_unbreached: {
        type: "boolean"
        description: "Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)"
      }
      password_requirements_apply_to_bundles: {
        type: "boolean"
        description: "Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?"
      }
      password_validity_days: {
        type: "integer"
        format: "int32"
        description: "Number of days password is valid"
      }
      phone: {
        type: "string"
        description: "Site phone number"
      }
      pin_all_remote_servers_to_site_region: {
        type: "boolean"
        description: "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."
      }
      reply_to_email: {
        type: "string"
        format: "email"
        description: "Reply-to email for this site"
      }
      require_2fa: {
        type: "boolean"
        description: "Require two-factor authentication for all users?"
      }
      require_2fa_stop_time: {
        type: "string"
        format: "date-time"
        description: "If set, requirement for two-factor authentication has been scheduled to end on this date-time."
      }
      require_2fa_user_type: {
        type: "string"
        description: "What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?"
        enum: ["all", "folder_and_site_admins", "site_admins"]
      }
      session: {
        type: "object"
        description: "Create user session (log in)"
        properties: {
          id: {
            type: "string"
            description: "Session ID"
          }
          language: {
            type: "string"
            description: "Session language"
          }
          read_only: {
            type: "boolean"
            description: "Is this session read only?"
          }
          sftp_insecure_ciphers: {
            type: "boolean"
            description: "Are insecure SFTP ciphers allowed for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure SSH ciphers for this user.)"
          }
        }
      }
      session_expiry: {
        type: "number"
        format: "double"
        description: "Session expiry in hours"
      }
      session_expiry_minutes: {
        type: "integer"
        format: "int32"
        description: "Session expiry in minutes"
      }
      session_pinned_by_ip: {
        type: "boolean"
        description: "Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)"
      }
      sftp_enabled: {
        type: "boolean"
        description: "Is SFTP enabled?"
      }
      sftp_host_key_type: {
        type: "string"
        description: "Sftp Host Key Type"
        enum: ["default", "exavault", "custom"]
      }
      sftp_insecure_ciphers: {
        type: "boolean"
        description: "Are Insecure Ciphers allowed for SFTP?  Note:  Settting TLS Disabled -> True will always allow insecure ciphers for SFTP as well.  Enabling this is insecure."
      }
      sftp_user_root_enabled: {
        type: "boolean"
        description: "Use user FTP roots also for SFTP?"
      }
      sharing_enabled: {
        type: "boolean"
        description: "Allow bundle creation"
      }
      show_request_access_link: {
        type: "boolean"
        description: "Show request access link for users without access?  Currently unused."
      }
      site_footer: {
        type: "string"
        description: "Custom site footer text"
      }
      site_header: {
        type: "string"
        description: "Custom site header text"
      }
      smtp_address: {
        type: "string"
        description: "SMTP server hostname or IP"
      }
      smtp_authentication: {
        type: "string"
        description: "SMTP server authentication type"
      }
      smtp_from: {
        type: "string"
        description: "From address to use when mailing through custom SMTP"
      }
      smtp_port: {
        type: "integer"
        format: "int32"
        description: "SMTP server port"
      }
      smtp_username: {
        type: "string"
        description: "SMTP server username"
      }
      ssl_required: {
        type: "boolean"
        description: "Is SSL required?  Disabling this is insecure."
      }
      subdomain: {
        type: "string"
        description: "Site subdomain"
      }
      switch_to_plan_date: {
        type: "string"
        format: "date-time"
        description: "If switching plans, when does the new plan take effect?"
      }
      tls_disabled: {
        type: "boolean"
        description: "Are Insecure TLS and SFTP Ciphers allowed?  Enabling this is insecure."
      }
      trial_days_left: {
        type: "integer"
        format: "int32"
        description: "Number of days left in trial"
      }
      trial_until: {
        type: "string"
        format: "date-time"
        description: "When does this Site trial expire?"
      }
      updated_at: {
        type: "string"
        format: "date-time"
        description: "Last time this Site was updated"
      }
      uploads_via_email_authentication: {
        type: "boolean"
        description: "Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?"
      }
      use_provided_modified_at: {
        type: "boolean"
        description: "Allow uploaders to set `provided_modified_at` for uploaded files?"
      }
      user: {
        type: "object"
        description: "Create User"
        properties: {
          active_2fa: {
            type: "boolean"
            description: "Is 2fa active for the user?"
          }
          admin_group_ids: {
            type: "array"
            description: "List of group IDs of which this user is an administrator"
            items: {
              type: "integer"
              format: "int32"
            }
          }
          allowed_ips: {
            type: "string"
            description: "A list of allowed IPs if applicable.  Newline delimited"
          }
          api_keys_count: {
            type: "integer"
            format: "int32"
            description: "Number of api keys associated with this user"
          }
          attachments_permission: {
            type: "boolean"
            description: "DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead."
          }
          authenticate_until: {
            type: "string"
            format: "date-time"
            description: "Scheduled Date/Time at which user will be deactivated"
          }
          authentication_method: {
            type: "string"
            description: "How is this user authenticated?"
            enum: ["password", "unused_former_ldap", "sso", "none", "email_signup", "password_with_imported_hash"]
          }
          avatar_url: {
            type: "string"
            description: "URL holding the user's avatar"
          }
          billing_permission: {
            type: "boolean"
            description: "Allow this user to perform operations on the account, payments, and invoices?"
          }
          bypass_inactive_disable: {
            type: "boolean"
            description: "Exempt this user from being disabled based on inactivity?"
          }
          bypass_site_allowed_ips: {
            type: "boolean"
            description: "Allow this user to skip site-wide IP blacklists?"
          }
          company: {
            type: "string"
            description: "User's company"
          }
          created_at: {
            type: "string"
            format: "date-time"
            description: "When this user was created"
          }
          dav_permission: {
            type: "boolean"
            description: "Can the user connect with WebDAV?"
          }
          days_remaining_until_password_expire: {
            type: "integer"
            format: "int32"
            description: "Number of days remaining until password expires"
          }
          disabled: {
            type: "boolean"
            description: "Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting."
          }
          email: {
            type: "string"
            format: "email"
            description: "User email address"
          }
          externally_managed: {
            type: "boolean"
            description: "Is this user managed by a SsoStrategy?"
          }
          first_login_at: {
            type: "string"
            format: "date-time"
            description: "User's first login time"
          }
          ftp_permission: {
            type: "boolean"
            description: "Can the user access with FTP/FTPS?"
          }
          group_ids: {
            type: "string"
            description: "Comma-separated list of group IDs of which this user is a member"
          }
          header_text: {
            type: "string"
            description: "Text to display to the user in the header of the UI"
          }
          id: {
            type: "integer"
            format: "int32"
            description: "User ID"
          }
          language: {
            type: "string"
            description: "Preferred language"
          }
          last_active_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation"
          }
          last_api_use_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent API use time"
          }
          last_dav_login_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent login time via WebDAV"
          }
          last_desktop_login_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent login time via Desktop app"
          }
          last_ftp_login_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent login time via FTP"
          }
          last_login_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent login time via any protocol"
          }
          last_protocol_cipher: {
            type: "string"
            description: "The most recent protocol and cipher used"
          }
          last_restapi_login_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent login time via Rest API"
          }
          last_sftp_login_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent login time via SFTP"
          }
          last_web_login_at: {
            type: "string"
            format: "date-time"
            description: "User's most recent login time via web"
          }
          lockout_expires: {
            type: "string"
            format: "date-time"
            description: "Time in the future that the user will no longer be locked out if applicable"
          }
          name: {
            type: "string"
            description: "User's full name"
          }
          notes: {
            type: "string"
            description: "Any internal notes on the user"
          }
          notification_daily_send_time: {
            type: "integer"
            format: "int32"
            description: "Hour of the day at which daily notifications should be sent. Can be in range 0 to 23"
          }
          office_integration_enabled: {
            type: "boolean"
            description: "Enable integration with Office for the web?"
          }
          password_expire_at: {
            type: "string"
            format: "date-time"
            description: "Password expiration datetime"
          }
          password_expired: {
            type: "boolean"
            description: "Is user's password expired?"
          }
          password_set_at: {
            type: "string"
            format: "date-time"
            description: "Last time the user's password was set"
          }
          password_validity_days: {
            type: "integer"
            format: "int32"
            description: "Number of days to allow user to use the same password"
          }
          public_keys_count: {
            type: "integer"
            format: "int32"
            description: "Number of public keys associated with this user"
          }
          receive_admin_alerts: {
            type: "boolean"
            description: "Should the user receive admin alerts such a certificate expiration notifications and overages?"
          }
          require_2fa: {
            type: "string"
            description: "2FA required setting"
            enum: ["use_system_setting", "always_require", "never_require"]
          }
          require_password_change: {
            type: "boolean"
            description: "Is a password change required upon next user login?"
          }
          restapi_permission: {
            type: "boolean"
            description: "Can this user access the REST API?"
          }
          self_managed: {
            type: "boolean"
            description: "Does this user manage it's own credentials or is it a shared/bot user?"
          }
          sftp_permission: {
            type: "boolean"
            description: "Can the user access with SFTP?"
          }
          site_admin: {
            type: "boolean"
            description: "Is the user an administrator for this site?"
          }
          skip_welcome_screen: {
            type: "boolean"
            description: "Skip Welcome page in the UI?"
          }
          ssl_required: {
            type: "string"
            description: "SSL required setting"
            enum: ["use_system_setting", "always_require", "never_require"]
          }
          sso_strategy_id: {
            type: "integer"
            format: "int32"
            description: "SSO (Single Sign On) strategy ID for the user, if applicable."
          }
          subscribe_to_newsletter: {
            type: "boolean"
            description: "Is the user subscribed to the newsletter?"
          }
          time_zone: {
            type: "string"
            description: "User time zone"
          }
          type_of_2fa: {
            type: "string"
            description: "Type(s) of 2FA methods in use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore."
          }
          user_root: {
            type: "string"
            description: "Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface."
          }
          username: {
            type: "string"
            description: "User's username"
          }
        }
      }
      user_lockout: {
        type: "boolean"
        description: "Will users be locked out after incorrect login attempts?"
      }
      user_lockout_lock_period: {
        type: "integer"
        format: "int32"
        description: "How many hours to lock user out for failed password?"
      }
      user_lockout_tries: {
        type: "integer"
        format: "int32"
        description: "Number of login tries within `user_lockout_within` hours before users are locked out"
      }
      user_lockout_within: {
        type: "integer"
        format: "int32"
        description: "Number of hours for user lockout window"
      }
      user_requests_enabled: {
        type: "boolean"
        description: "Enable User Requests feature"
      }
      user_requests_notify_admins: {
        type: "boolean"
        description: "Send email to site admins when a user request is received?"
      }
      welcome_custom_text: {
        type: "string"
        description: "Custom text send in user welcome email"
      }
      welcome_email_cc: {
        type: "string"
        format: "email"
        description: "Include this email in welcome emails if enabled"
      }
      welcome_email_enabled: {
        type: "boolean"
        description: "Will the welcome email be sent to new users?"
      }
      welcome_email_subject: {
        type: "string"
        description: "Include this email subject in welcome emails if enabled"
      }
      welcome_screen: {
        type: "string"
        description: "Does the welcome screen appear?"
        enum: ["enabled", "hidden", "disabled"]
      }
      windows_mode_ftp: {
        type: "boolean"
        description: "Does FTP user Windows emulation mode?"
      }
    }
  }
}