files.com 1.0.92

data/docs/request.md

@@ -0,0 +1,100 @@
+# Request
+
+## Example Request Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "source": "",
+  "destination": "",
+  "automation_id": "",
+  "user_display_name": ""
+}
+```
+
+* `id` (int64): Request ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `source` (string): Source filename, if applicable
+* `destination` (string): Destination filename
+* `automation_id` (string): ID of automation that created request
+* `user_display_name` (string): User making the request (if applicable)
+* `user_ids` (string): A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
+* `group_ids` (string): A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
+
+
+---
+
+## List Requests
+
+```
+Files::Request.list(path, 
+  page: 1, 
+  per_page: 1, 
+  mine: true
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `folder_id` or `destination`.
+* `mine` (boolean): Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+* `path` (string): Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
+
+
+---
+
+## List Requests
+
+```
+Files::Request.find_folder(path, 
+  page: 1, 
+  per_page: 1, 
+  mine: true
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `folder_id` or `destination`.
+* `mine` (boolean): Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+* `path` (string): Required - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
+
+
+---
+
+## Create Request
+
+```
+Files::Request.create(path, 
+  destination: "destination"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Folder path on which to request the file.
+* `destination` (string): Required - Destination filename (without extension) to request.
+* `user_ids` (string): A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
+* `group_ids` (string): A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
+
+
+---
+
+## Delete Request
+
+```
+Files::Request.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Request ID.

data/docs/session.md

@@ -0,0 +1,78 @@
+# Session
+
+## Example Session Object
+
+```
+{
+  "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
+  "language": "en",
+  "login_token": "@tok-randomcode",
+  "login_token_domain": "https://mysite.files.com",
+  "max_dir_listing_size": 1,
+  "multiple_regions": true,
+  "read_only": "en",
+  "root_path": "",
+  "site_id": 1,
+  "ssl_required": true,
+  "tls_disabled": true,
+  "two_factor_setup_needed": true,
+  "allowed_2fa_method_sms": true,
+  "allowed_2fa_method_totp": true,
+  "allowed_2fa_method_u2f": true,
+  "allowed_2fa_method_yubi": true,
+  "use_provided_modified_at": true,
+  "windows_mode_ftp": true
+}
+```
+
+* `id` (string): Session ID
+* `language` (string): Session language
+* `login_token` (string): Login token. If set, this token will allow your user to log in via browser at the domain in `login_token_domain`.
+* `login_token_domain` (string): Domain to use with `login_token`.
+* `max_dir_listing_size` (int64): Maximum number of files to retrieve per folder for a directory listing.  This is based on the user's plan.
+* `multiple_regions` (boolean): Can access multiple regions?
+* `read_only` (boolean): Is this session read only?
+* `root_path` (string): Initial root path to start the user's session in.
+* `site_id` (int64): Site ID
+* `ssl_required` (boolean): Is SSL required for this user?  (If so, ensure all your communications with this user use SSL.)
+* `tls_disabled` (boolean): Is strong TLS disabled for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure TLS versions for this user.)
+* `two_factor_setup_needed` (boolean): If true, this user needs to add a Two Factor Authentication method before performing any further actions.
+* `allowed_2fa_method_sms` (boolean): Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
+* `allowed_2fa_method_totp` (boolean): Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
+* `allowed_2fa_method_u2f` (boolean): Sent only if 2FA setup is needed. Is U2F two factor authentication allowed?
+* `allowed_2fa_method_yubi` (boolean): Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
+* `use_provided_modified_at` (boolean): Allow the user to provide file/folder modified at dates?  If false, the server will always use the current date/time.
+* `windows_mode_ftp` (boolean): Does this user want to use Windows line-ending emulation?  (CR vs CRLF)
+* `username` (string): Username to sign in as
+* `password` (string): Password for sign in
+* `otp` (string): If this user has a 2FA device, provide its OTP or code here.
+* `partial_session_id` (string): Identifier for a partially-completed login
+
+
+---
+
+## Create user session (log in)
+
+```
+Files::Session.create(
+  username: "username", 
+  password: "password", 
+  otp: "123456"
+)
+```
+
+### Parameters
+
+* `username` (string): Username to sign in as
+* `password` (string): Password for sign in
+* `otp` (string): If this user has a 2FA device, provide its OTP or code here.
+* `partial_session_id` (string): Identifier for a partially-completed login
+
+
+---
+
+## Delete user session (log out)
+
+```
+Files::Session.delete
+```

data/docs/site.md

@@ -0,0 +1,448 @@
+# Site
+
+## Example Site Object
+
+```
+{
+  "name": "My Site",
+  "allowed_2fa_method_sms": true,
+  "allowed_2fa_method_totp": true,
+  "allowed_2fa_method_u2f": true,
+  "allowed_2fa_method_yubi": true,
+  "admin_user_id": 1,
+  "allow_bundle_names": true,
+  "allowed_ips": "",
+  "ask_about_overwrites": true,
+  "bundle_expiration": 1,
+  "bundle_password_required": true,
+  "color2_left": "#0066a7",
+  "color2_link": "#d34f5d",
+  "color2_text": "#0066a7",
+  "color2_top": "#000000",
+  "color2_top_text": "#ffffff",
+  "created_at": "2000-01-01T01:00:00Z",
+  "currency": "USD",
+  "custom_namespace": true,
+  "days_to_retain_backups": 30,
+  "default_time_zone": "Pacific Time (US & Canada)",
+  "desktop_app": true,
+  "desktop_app_session_ip_pinning": true,
+  "desktop_app_session_lifetime": 1,
+  "disable_notifications": true,
+  "disable_password_reset": true,
+  "domain": "my-custom-domain.com",
+  "email": "john.doe@files.com",
+  "non_sso_groups_allowed": true,
+  "non_sso_users_allowed": true,
+  "folder_permissions_groups_only": true,
+  "hipaa": true,
+  "icon128": "",
+  "icon16": "",
+  "icon32": "",
+  "icon48": "",
+  "immutable_files_set_at": "2000-01-01T01:00:00Z",
+  "include_password_in_welcome_email": true,
+  "language": "en",
+  "ldap_base_dn": "",
+  "ldap_domain": "mysite.com",
+  "ldap_enabled": true,
+  "ldap_group_action": "disabled",
+  "ldap_group_exclusion": "",
+  "ldap_group_inclusion": "",
+  "ldap_host": "ldap.site.com",
+  "ldap_host_2": "ldap2.site.com",
+  "ldap_host_3": "ldap3.site.com",
+  "ldap_port": 1,
+  "ldap_secure": true,
+  "ldap_type": "open_ldap",
+  "ldap_user_action": "disabled",
+  "ldap_user_include_groups": "",
+  "ldap_username": "[ldap username]",
+  "ldap_username_field": "sAMAccountName",
+  "login_help_text": "Login page help text.",
+  "logo": "",
+  "max_prior_passwords": 1,
+  "next_billing_amount": "",
+  "next_billing_date": "Apr 20",
+  "office_integration_available": true,
+  "opt_out_global": true,
+  "overage_notified_at": "2000-01-01T01:00:00Z",
+  "overage_notify": true,
+  "overdue": true,
+  "password_min_length": 1,
+  "password_require_letter": true,
+  "password_require_mixed": true,
+  "password_require_number": true,
+  "password_require_special": true,
+  "password_require_unbreached": true,
+  "password_requirements_apply_to_bundles": true,
+  "password_validity_days": 1,
+  "phone": "555-555-5555",
+  "require_2fa": true,
+  "require_2fa_stop_time": "2000-01-01T01:00:00Z",
+  "require_2fa_user_type": "`site_admins`",
+  "session": "",
+  "session_pinned_by_ip": true,
+  "sftp_user_root_enabled": true,
+  "sharing_enabled": true,
+  "show_request_access_link": true,
+  "site_footer": "",
+  "site_header": "",
+  "smtp_address": "smtp.my-mail-server.com",
+  "smtp_authentication": "plain",
+  "smtp_from": "me@my-mail-server.com",
+  "smtp_port": 25,
+  "smtp_username": "mail",
+  "session_expiry": 6.0,
+  "ssl_required": true,
+  "subdomain": "mysite",
+  "switch_to_plan_date": "2000-01-01T01:00:00Z",
+  "tls_disabled": true,
+  "trial_days_left": 1,
+  "trial_until": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z",
+  "use_provided_modified_at": true,
+  "user": "",
+  "user_lockout": true,
+  "user_lockout_lock_period": 1,
+  "user_lockout_tries": 1,
+  "user_lockout_within": 6,
+  "user_requests_enabled": true,
+  "welcome_custom_text": "Welcome to my site!",
+  "welcome_email_cc": "",
+  "welcome_email_enabled": true,
+  "welcome_screen": "user_controlled",
+  "windows_mode_ftp": true,
+  "disable_users_from_inactivity_period_days": 1
+}
+```
+
+* `name` (string): Site name
+* `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
+* `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
+* `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
+* `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
+* `admin_user_id` (int64): User ID for the main site administrator
+* `allow_bundle_names` (boolean): Are manual Bundle names allowed?
+* `allowed_ips` (string): List of allowed IP addresses
+* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation.  Only applies to web interface.
+* `bundle_expiration` (int64): Site-wide Bundle expiration in days
+* `bundle_password_required` (boolean): Do Bundles require password protection?
+* `color2_left` (string): Page link and button color
+* `color2_link` (string): Top bar link color
+* `color2_text` (string): Page link and button color
+* `color2_top` (string): Top bar background color
+* `color2_top_text` (string): Top bar text color
+* `created_at` (date-time): Time this site was created
+* `currency` (string): Preferred currency
+* `custom_namespace` (boolean): Is this site using a custom namespace for users?
+* `days_to_retain_backups` (int64): Number of days to keep deleted files
+* `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)
+* `disable_notifications` (boolean): Are notifications disabled?
+* `disable_password_reset` (boolean): Is password reset disabled?
+* `domain` (string): Custom domain
+* `email` (email): Main email for this site
+* `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.
+* `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.
+* `hipaa` (boolean): Is there a signed HIPAA BAA between Files.com and this site?
+* `icon128`: Branded icon 128x128
+* `icon16`: Branded icon 16x16
+* `icon32`: Branded icon 32x32
+* `icon48`: Branded icon 48x48
+* `immutable_files_set_at` (date-time): Can files be modified?
+* `include_password_in_welcome_email` (boolean): Include password in emails to new users?
+* `language` (string): Site default language
+* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
+* `ldap_domain` (string): Domain name that will be appended to usernames
+* `ldap_enabled` (boolean): Main LDAP setting: is LDAP enabled?
+* `ldap_group_action` (string): Should we sync groups from LDAP server?
+* `ldap_group_exclusion` (string): Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
+* `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
+* `ldap_host` (string): LDAP host
+* `ldap_host_2` (string): LDAP backup host
+* `ldap_host_3` (string): LDAP backup host
+* `ldap_port` (int64): LDAP port
+* `ldap_secure` (boolean): Use secure LDAP?
+* `ldap_type` (string): LDAP type
+* `ldap_user_action` (string): Should we sync users from LDAP server?
+* `ldap_user_include_groups` (string): Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
+* `ldap_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
+* `login_help_text` (string): Login help text
+* `logo`: Branded logo
+* `max_prior_passwords` (int64): Number of prior passwords to disallow
+* `next_billing_amount` (double): Next billing amount
+* `next_billing_date` (string): Next billing date
+* `office_integration_available` (boolean): Allow users to use Office for the web?
+* `opt_out_global` (boolean): Use servers in the USA only?
+* `overage_notified_at` (date-time): Last time the site was notified about an overage
+* `overage_notify` (boolean): Notify site email of overages?
+* `overdue` (boolean): Is this site's billing overdue?
+* `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_number` (boolean): Require a number in passwords?
+* `password_require_special` (boolean): Require special characters in password?
+* `password_require_unbreached` (boolean): Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
+* `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?
+* `password_validity_days` (int64): Number of days password is valid
+* `phone` (string): Site phone number
+* `require_2fa` (boolean): Require two-factor authentication for all users?
+* `require_2fa_stop_time` (date-time): If set, requirement for two-factor authentication has been scheduled to end on this date-time.
+* `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)?
+* `session`: Current session
+* `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?)
+* `sftp_user_root_enabled` (boolean): Use user FTP roots also for SFTP?
+* `sharing_enabled` (boolean): Allow bundle creation
+* `show_request_access_link` (boolean): Show request access link for users without access?  Currently unused.
+* `site_footer` (string): Custom site footer text
+* `site_header` (string): Custom site header text
+* `smtp_address` (string): SMTP server hostname or IP
+* `smtp_authentication` (string): SMTP server authentication type
+* `smtp_from` (string): From address to use when mailing through custom SMTP
+* `smtp_port` (int64): SMTP server port
+* `smtp_username` (string): SMTP server username
+* `session_expiry` (double): Session expiry in hours
+* `ssl_required` (boolean): Is SSL required?  Disabling this is insecure.
+* `subdomain` (string): Site subdomain
+* `switch_to_plan_date` (date-time): If switching plans, when does the new plan take effect?
+* `tls_disabled` (boolean): Is TLS disabled(site setting)?
+* `trial_days_left` (int64): Number of days left in trial
+* `trial_until` (date-time): When does this Site trial expire?
+* `updated_at` (date-time): Last time this Site was updated
+* `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?
+* `user`: User of current session
+* `user_lockout` (boolean): Will users be locked out after incorrect login attempts?
+* `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
+* `user_lockout_tries` (int64): Number of login tries within `user_lockout_within` hours before users are locked out
+* `user_lockout_within` (int64): Number of hours for user lockout window
+* `user_requests_enabled` (boolean): Enable User Requests feature
+* `welcome_custom_text` (string): Custom text send in user welcome email
+* `welcome_email_cc` (email): Include this email in welcome emails if enabled
+* `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
+* `welcome_screen` (string): Does the welcome screen appear?
+* `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
+* `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.
+
+
+---
+
+## Show site settings
+
+```
+Files::Site.get
+```
+
+
+---
+
+## Get the most recent usage snapshot (usage data for billing purposes) for a Site
+
+```
+Files::Site.get_usage
+```
+
+
+---
+
+## Update site settings
+
+```
+Files::Site.update(
+  name: "My Site", 
+  subdomain: "mysite", 
+  domain: "my-custom-domain.com", 
+  email: "john.doe@files.com", 
+  allow_bundle_names: true, 
+  bundle_expiration: 1, 
+  overage_notify: true, 
+  welcome_email_enabled: true, 
+  ask_about_overwrites: true, 
+  show_request_access_link: true, 
+  welcome_custom_text: "Welcome to my site!", 
+  language: "en", 
+  windows_mode_ftp: true, 
+  default_time_zone: "Pacific Time (US & Canada)", 
+  desktop_app: true, 
+  desktop_app_session_ip_pinning: true, 
+  desktop_app_session_lifetime: 1, 
+  folder_permissions_groups_only: true, 
+  welcome_screen: "user_controlled", 
+  office_integration_available: true, 
+  session_expiry: 1.0, 
+  ssl_required: true, 
+  tls_disabled: true, 
+  user_lockout: true, 
+  user_lockout_tries: 1, 
+  user_lockout_within: 1, 
+  user_lockout_lock_period: 1, 
+  include_password_in_welcome_email: true, 
+  days_to_retain_backups: 1, 
+  max_prior_passwords: 1, 
+  password_validity_days: 1, 
+  password_min_length: 1, 
+  password_require_letter: true, 
+  password_require_mixed: true, 
+  password_require_special: true, 
+  password_require_number: true, 
+  password_require_unbreached: true, 
+  sftp_user_root_enabled: true, 
+  disable_password_reset: true, 
+  immutable_files: true, 
+  session_pinned_by_ip: true, 
+  bundle_password_required: true, 
+  password_requirements_apply_to_bundles: true, 
+  opt_out_global: true, 
+  use_provided_modified_at: true, 
+  custom_namespace: true, 
+  disable_users_from_inactivity_period_days: 1, 
+  non_sso_groups_allowed: true, 
+  non_sso_users_allowed: true, 
+  sharing_enabled: true, 
+  user_requests_enabled: true, 
+  allowed_2fa_method_sms: true, 
+  allowed_2fa_method_u2f: true, 
+  allowed_2fa_method_totp: true, 
+  allowed_2fa_method_yubi: true, 
+  require_2fa: true, 
+  require_2fa_user_type: "`site_admins`", 
+  color2_top: "#000000", 
+  color2_left: "#0066a7", 
+  color2_link: "#d34f5d", 
+  color2_text: "#0066a7", 
+  color2_top_text: "#ffffff", 
+  login_help_text: "Login page help text.", 
+  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: true, 
+  ldap_type: "open_ldap", 
+  ldap_host: "ldap.site.com", 
+  ldap_host_2: "ldap2.site.com", 
+  ldap_host_3: "ldap3.site.com", 
+  ldap_port: 1, 
+  ldap_secure: true, 
+  ldap_username: "[ldap username]", 
+  ldap_username_field: "sAMAccountName", 
+  ldap_domain: "mysite.com", 
+  ldap_user_action: "disabled", 
+  ldap_group_action: "disabled", 
+  icon16_delete: true, 
+  icon32_delete: true, 
+  icon48_delete: true, 
+  icon128_delete: true, 
+  logo_delete: true, 
+  disable_2fa_with_delay: true
+)
+```
+
+### Parameters
+
+* `name` (string): Site name
+* `subdomain` (string): Site subdomain
+* `domain` (string): Custom domain
+* `email` (string): Main email for this site
+* `allow_bundle_names` (boolean): Are manual Bundle names allowed?
+* `bundle_expiration` (int64): Site-wide Bundle expiration in days
+* `overage_notify` (boolean): Notify site email of overages?
+* `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.
+* `welcome_email_cc` (string): Include this email 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)
+* `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?
+* `session_expiry` (double): Session expiry in hours
+* `ssl_required` (boolean): Is SSL required?  Disabling this is insecure.
+* `tls_disabled` (boolean): Is TLS disabled(site setting)?
+* `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_ips` (string): List of allowed IP addresses
+* `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/)
+* `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_password_required` (boolean): Do Bundles require password protection?
+* `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?
+* `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
+* `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_yubi` (boolean): Is yubikey two factor authentication allowed?
+* `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
+* `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
+* `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
+* `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.