files.com 1.1.671 → 1.1.673
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/action_log.md +1 -21
- data/docs/action_notification_export_result.md +0 -17
- data/docs/ai_assistant_personality.md +0 -14
- data/docs/ai_task.md +0 -14
- data/docs/api_key.md +1 -27
- data/docs/api_request_log.md +1 -21
- data/docs/app.md +0 -15
- data/docs/as2_incoming_message.md +0 -18
- data/docs/as2_outgoing_message.md +0 -18
- data/docs/as2_partner.md +0 -14
- data/docs/as2_station.md +0 -14
- data/docs/automation.md +1 -22
- data/docs/automation_log.md +1 -21
- data/docs/automation_run.md +0 -19
- data/docs/bandwidth_snapshot.md +0 -18
- data/docs/behavior.md +0 -14
- data/docs/bundle.md +1 -50
- data/docs/bundle_action.md +0 -25
- data/docs/bundle_download.md +0 -23
- data/docs/bundle_notification.md +0 -19
- data/docs/bundle_recipient.md +0 -21
- data/docs/bundle_registration.md +0 -61
- data/docs/chat_session.md +2 -14
- data/docs/child_site_management_policy.md +0 -9
- data/docs/clickwrap.md +0 -13
- data/docs/custom_domain.md +0 -13
- data/docs/desktop_configuration_profile.md +0 -14
- data/docs/dns_record.md +0 -9
- data/docs/email_incoming_message.md +0 -19
- data/docs/email_log.md +1 -20
- data/docs/event_channel.md +0 -14
- data/docs/event_delivery_attempt.md +0 -14
- data/docs/event_record.md +0 -19
- data/docs/event_subscription.md +0 -14
- data/docs/event_target.md +0 -14
- data/docs/exavault_api_request_log.md +1 -21
- data/docs/expectation.md +0 -14
- data/docs/expectation_evaluation.md +0 -14
- data/docs/expectation_incident.md +0 -14
- data/docs/external_event.md +0 -18
- data/docs/file.md +2 -90
- data/docs/file_migration.md +0 -32
- data/docs/file_migration_log.md +1 -20
- data/docs/file_upload_part.md +1 -3
- data/docs/folder.md +0 -20
- data/docs/form_field_set.md +0 -15
- data/docs/ftp_action_log.md +1 -21
- data/docs/gpg_key.md +0 -21
- data/docs/group.md +0 -19
- data/docs/group_user.md +2 -22
- data/docs/history.md +0 -85
- data/docs/history_export_result.md +0 -17
- data/docs/holiday_region.md +0 -9
- data/docs/inbound_s3_log.md +1 -21
- data/docs/inbox_recipient.md +0 -19
- data/docs/inbox_registration.md +0 -57
- data/docs/inbox_upload.md +0 -18
- data/docs/invoice.md +0 -9
- data/docs/ip_address.md +0 -59
- data/docs/key_lifecycle_rule.md +0 -14
- data/docs/lock.md +0 -15
- data/docs/message.md +0 -17
- data/docs/message_comment.md +0 -18
- data/docs/message_comment_reaction.md +0 -18
- data/docs/message_reaction.md +0 -17
- data/docs/metadata_category.md +0 -13
- data/docs/notification.md +0 -20
- data/docs/outbound_connection_log.md +1 -21
- data/docs/partner.md +0 -14
- data/docs/partner_channel.md +0 -14
- data/docs/partner_site_request.md +0 -14
- data/docs/payment.md +0 -9
- data/docs/pending_work_event.md +0 -18
- data/docs/permission.md +0 -22
- data/docs/preview.md +0 -57
- data/docs/project.md +0 -9
- data/docs/public_hosting_request_log.md +1 -21
- data/docs/public_key.md +0 -21
- data/docs/remote_bandwidth_snapshot.md +0 -18
- data/docs/remote_mount_backend.md +0 -13
- data/docs/remote_server.md +0 -233
- data/docs/remote_server_credential.md +0 -15
- data/docs/request.md +0 -17
- data/docs/restore.md +0 -14
- data/docs/scheduled_export.md +0 -15
- data/docs/scim_log.md +0 -13
- data/docs/session.md +1 -232
- data/docs/settings_change.md +0 -16
- data/docs/sftp_action_log.md +1 -21
- data/docs/sftp_host_key.md +0 -9
- data/docs/share_group.md +0 -15
- data/docs/siem_http_destination.md +0 -9
- data/docs/siem_http_destination_event.md +0 -18
- data/docs/site.md +0 -179
- data/docs/site_subdomain_redirect.md +0 -13
- data/docs/snapshot.md +0 -9
- data/docs/sso_event.md +0 -19
- data/docs/sso_strategy.md +0 -406
- data/docs/sync.md +0 -14
- data/docs/sync_log.md +1 -20
- data/docs/sync_run.md +0 -21
- data/docs/usage_daily_snapshot.md +0 -18
- data/docs/usage_snapshot.md +0 -9
- data/docs/user.md +2 -49
- data/docs/user_cipher_use.md +0 -21
- data/docs/user_lifecycle_rule.md +0 -14
- data/docs/user_request.md +0 -9
- data/docs/user_security_event.md +0 -18
- data/docs/user_sftp_client_use.md +0 -15
- data/docs/web_dav_action_log.md +1 -21
- data/docs/workspace.md +0 -15
- data/lib/files.com/models/action_log.rb +0 -24
- data/lib/files.com/models/action_notification_export_result.rb +0 -12
- data/lib/files.com/models/ai_assistant_personality.rb +0 -11
- data/lib/files.com/models/ai_task.rb +0 -11
- data/lib/files.com/models/api_key.rb +5 -39
- data/lib/files.com/models/api_request_log.rb +0 -24
- data/lib/files.com/models/app.rb +0 -13
- data/lib/files.com/models/as2_incoming_message.rb +0 -19
- data/lib/files.com/models/as2_outgoing_message.rb +0 -19
- data/lib/files.com/models/as2_partner.rb +0 -11
- data/lib/files.com/models/as2_station.rb +0 -11
- data/lib/files.com/models/automation.rb +0 -30
- data/lib/files.com/models/automation_log.rb +0 -24
- data/lib/files.com/models/automation_run.rb +0 -16
- data/lib/files.com/models/bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/behavior.rb +0 -11
- data/lib/files.com/models/bundle.rb +0 -52
- data/lib/files.com/models/bundle_action.rb +0 -25
- data/lib/files.com/models/bundle_download.rb +0 -23
- data/lib/files.com/models/bundle_notification.rb +0 -15
- data/lib/files.com/models/bundle_recipient.rb +0 -27
- data/lib/files.com/models/bundle_registration.rb +0 -125
- data/lib/files.com/models/chat_session.rb +5 -11
- data/lib/files.com/models/child_site_management_policy.rb +0 -5
- data/lib/files.com/models/clickwrap.rb +0 -9
- data/lib/files.com/models/custom_domain.rb +0 -9
- data/lib/files.com/models/desktop_configuration_profile.rb +0 -11
- data/lib/files.com/models/dns_record.rb +0 -5
- data/lib/files.com/models/email_incoming_message.rb +0 -21
- data/lib/files.com/models/email_log.rb +0 -22
- data/lib/files.com/models/event_channel.rb +0 -11
- data/lib/files.com/models/event_delivery_attempt.rb +0 -11
- data/lib/files.com/models/event_record.rb +0 -21
- data/lib/files.com/models/event_subscription.rb +0 -11
- data/lib/files.com/models/event_target.rb +0 -11
- data/lib/files.com/models/exavault_api_request_log.rb +0 -24
- data/lib/files.com/models/expectation.rb +0 -11
- data/lib/files.com/models/expectation_evaluation.rb +0 -11
- data/lib/files.com/models/expectation_incident.rb +0 -11
- data/lib/files.com/models/external_event.rb +0 -19
- data/lib/files.com/models/file.rb +67 -207
- data/lib/files.com/models/file_migration.rb +0 -27
- data/lib/files.com/models/file_migration_log.rb +0 -22
- data/lib/files.com/models/file_upload_part.rb +0 -5
- data/lib/files.com/models/folder.rb +0 -69
- data/lib/files.com/models/form_field_set.rb +0 -9
- data/lib/files.com/models/ftp_action_log.rb +0 -24
- data/lib/files.com/models/gpg_key.rb +0 -21
- data/lib/files.com/models/group.rb +0 -16
- data/lib/files.com/models/group_user.rb +1 -21
- data/lib/files.com/models/history.rb +0 -94
- data/lib/files.com/models/history_export_result.rb +0 -12
- data/lib/files.com/models/holiday_region.rb +0 -5
- data/lib/files.com/models/inbound_s3_log.rb +0 -24
- data/lib/files.com/models/inbox_recipient.rb +0 -25
- data/lib/files.com/models/inbox_registration.rb +0 -121
- data/lib/files.com/models/inbox_upload.rb +0 -19
- data/lib/files.com/models/invoice.rb +0 -5
- data/lib/files.com/models/ip_address.rb +0 -37
- data/lib/files.com/models/key_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/lock.rb +0 -27
- data/lib/files.com/models/message.rb +0 -12
- data/lib/files.com/models/message_comment.rb +0 -14
- data/lib/files.com/models/message_comment_reaction.rb +0 -14
- data/lib/files.com/models/message_reaction.rb +0 -12
- data/lib/files.com/models/metadata_category.rb +0 -9
- data/lib/files.com/models/notification.rb +0 -18
- data/lib/files.com/models/outbound_connection_log.rb +0 -24
- data/lib/files.com/models/partner.rb +0 -11
- data/lib/files.com/models/partner_channel.rb +0 -11
- data/lib/files.com/models/partner_site_request.rb +0 -11
- data/lib/files.com/models/payment.rb +0 -5
- data/lib/files.com/models/pending_work_event.rb +0 -19
- data/lib/files.com/models/permission.rb +0 -22
- data/lib/files.com/models/preview.rb +0 -57
- data/lib/files.com/models/project.rb +0 -5
- data/lib/files.com/models/public_hosting_request_log.rb +0 -24
- data/lib/files.com/models/public_key.rb +0 -21
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/remote_mount_backend.rb +0 -9
- data/lib/files.com/models/remote_server.rb +0 -297
- data/lib/files.com/models/remote_server_credential.rb +0 -13
- data/lib/files.com/models/request.rb +0 -12
- data/lib/files.com/models/restore.rb +0 -11
- data/lib/files.com/models/scheduled_export.rb +0 -13
- data/lib/files.com/models/scim_log.rb +0 -9
- data/lib/files.com/models/session.rb +0 -493
- data/lib/files.com/models/settings_change.rb +0 -16
- data/lib/files.com/models/sftp_action_log.rb +0 -24
- data/lib/files.com/models/sftp_host_key.rb +0 -5
- data/lib/files.com/models/share_group.rb +0 -9
- data/lib/files.com/models/siem_http_destination.rb +0 -5
- data/lib/files.com/models/siem_http_destination_event.rb +0 -19
- data/lib/files.com/models/site.rb +0 -1021
- data/lib/files.com/models/site_subdomain_redirect.rb +0 -9
- data/lib/files.com/models/snapshot.rb +0 -5
- data/lib/files.com/models/sso_event.rb +0 -21
- data/lib/files.com/models/sso_strategy.rb +0 -632
- data/lib/files.com/models/sync.rb +0 -11
- data/lib/files.com/models/sync_log.rb +0 -22
- data/lib/files.com/models/sync_run.rb +0 -21
- data/lib/files.com/models/usage_daily_snapshot.rb +0 -19
- data/lib/files.com/models/usage_snapshot.rb +0 -5
- data/lib/files.com/models/user.rb +0 -59
- data/lib/files.com/models/user_cipher_use.rb +0 -21
- data/lib/files.com/models/user_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/user_request.rb +0 -5
- data/lib/files.com/models/user_security_event.rb +0 -19
- data/lib/files.com/models/user_sftp_client_use.rb +0 -9
- data/lib/files.com/models/web_dav_action_log.rb +0 -24
- data/lib/files.com/models/workspace.rb +0 -13
- data/lib/files.com/path_util.rb +1 -1
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +0 -59
- data/shared/normalization_for_comparison_test_data.json +3 -1
- data/spec/models/file_underscore_destinations_spec.rb +24 -0
- data/spec/path_util_spec.rb +5 -0
- metadata +2 -119
- data/docs/account.md +0 -155
- data/docs/action_webhook_failure.md +0 -28
- data/docs/agent_proxy_identity.md +0 -49
- data/docs/agent_proxy_identity_endpoint.md +0 -11
- data/docs/agent_proxy_identity_result.md +0 -24
- data/docs/agent_v2_auth.md +0 -17
- data/docs/announcement.md +0 -57
- data/docs/blog_post.md +0 -57
- data/docs/bundle_recipient_registration.md +0 -39
- data/docs/certificate.md +0 -258
- data/docs/child_site.md +0 -583
- data/docs/clickwrap_acceptance.md +0 -30
- data/docs/client_log.md +0 -17
- data/docs/crash_report.md +0 -50
- data/docs/custom_domain_for_proxy.md +0 -23
- data/docs/email_preference.md +0 -108
- data/docs/email_preference_bundle_notification.md +0 -15
- data/docs/email_preference_notification.md +0 -17
- data/docs/export.md +0 -90
- data/docs/front_end_server.md +0 -111
- data/docs/frontend_metric.md +0 -34
- data/docs/inbox.md +0 -102
- data/docs/inbox_recipient_registration.md +0 -35
- data/docs/ip.md +0 -63
- data/docs/ip_abuse_entry.md +0 -47
- data/docs/label.md +0 -9
- data/docs/lead.md +0 -161
- data/docs/monitoring_stat.md +0 -38
- data/docs/monitoring_stats.md +0 -15
- data/docs/mover_package.md +0 -68
- data/docs/nps_response.md +0 -75
- data/docs/oauth_redirect.md +0 -11
- data/docs/paired_api_key.md +0 -19
- data/docs/paypal_express_info.md +0 -31
- data/docs/paypal_express_url.md +0 -11
- data/docs/plan.md +0 -107
- data/docs/public_hosting_session_pairing.md +0 -15
- data/docs/public_inbox.md +0 -121
- data/docs/public_url.md +0 -59
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +0 -83
- data/docs/release_package.md +0 -19
- data/docs/revision.md +0 -40
- data/docs/safe_plan.md +0 -0
- data/docs/session_available_site.md +0 -26
- data/docs/setting.md +0 -33
- data/docs/settings.md +0 -498
- data/docs/ssl_certificate.md +0 -37
- data/docs/staging_site.md +0 -591
- data/docs/support_request.md +0 -126
- data/docs/sync_api_usage_snapshot.md +0 -23
- data/docs/sync_api_usage_snapshot_report.md +0 -71
- data/docs/sync_bandwidth_snapshot.md +0 -48
- data/docs/two_factor_authentication_method.md +0 -169
- data/docs/warning.md +0 -36
- data/docs/webauthn_sign_request.md +0 -13
- data/docs/zip_download.md +0 -32
- data/docs/zip_download_file.md +0 -45
- data/docs/zip_download_files.md +0 -23
- data/lib/files.com/models/account.rb +0 -346
- data/lib/files.com/models/action_webhook_failure.rb +0 -34
- data/lib/files.com/models/agent_proxy_identity.rb +0 -47
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +0 -17
- data/lib/files.com/models/agent_proxy_identity_result.rb +0 -27
- data/lib/files.com/models/agent_v2_auth.rb +0 -32
- data/lib/files.com/models/announcement.rb +0 -89
- data/lib/files.com/models/blog_post.rb +0 -84
- data/lib/files.com/models/bundle_recipient_registration.rb +0 -105
- data/lib/files.com/models/certificate.rb +0 -455
- data/lib/files.com/models/child_site.rb +0 -1756
- data/lib/files.com/models/clickwrap_acceptance.rb +0 -56
- data/lib/files.com/models/client_log.rb +0 -25
- data/lib/files.com/models/crash_report.rb +0 -151
- data/lib/files.com/models/custom_domain_for_proxy.rb +0 -47
- data/lib/files.com/models/email_preference.rb +0 -124
- data/lib/files.com/models/email_preference_bundle_notification.rb +0 -27
- data/lib/files.com/models/email_preference_notification.rb +0 -32
- data/lib/files.com/models/export.rb +0 -153
- data/lib/files.com/models/front_end_server.rb +0 -335
- data/lib/files.com/models/frontend_metric.rb +0 -65
- data/lib/files.com/models/inbox.rb +0 -123
- data/lib/files.com/models/inbox_recipient_registration.rb +0 -87
- data/lib/files.com/models/ip.rb +0 -82
- data/lib/files.com/models/ip_abuse_entry.rb +0 -96
- data/lib/files.com/models/label.rb +0 -22
- data/lib/files.com/models/lead.rb +0 -434
- data/lib/files.com/models/monitoring_stat.rb +0 -43
- data/lib/files.com/models/monitoring_stats.rb +0 -22
- data/lib/files.com/models/mover_package.rb +0 -80
- data/lib/files.com/models/nps_response.rb +0 -128
- data/lib/files.com/models/oauth_redirect.rb +0 -17
- data/lib/files.com/models/paired_api_key.rb +0 -37
- data/lib/files.com/models/paypal_express_info.rb +0 -67
- data/lib/files.com/models/paypal_express_url.rb +0 -17
- data/lib/files.com/models/plan.rb +0 -209
- data/lib/files.com/models/public_hosting_session_pairing.rb +0 -27
- data/lib/files.com/models/public_inbox.rb +0 -142
- data/lib/files.com/models/public_url.rb +0 -177
- data/lib/files.com/models/regional_migration.rb +0 -12
- data/lib/files.com/models/release.rb +0 -153
- data/lib/files.com/models/release_package.rb +0 -37
- data/lib/files.com/models/revision.rb +0 -53
- data/lib/files.com/models/safe_plan.rb +0 -12
- data/lib/files.com/models/session_available_site.rb +0 -47
- data/lib/files.com/models/setting.rb +0 -36
- data/lib/files.com/models/settings.rb +0 -1072
- data/lib/files.com/models/ssl_certificate.rb +0 -77
- data/lib/files.com/models/staging_site.rb +0 -1781
- data/lib/files.com/models/support_request.rb +0 -209
- data/lib/files.com/models/sync_api_usage_snapshot.rb +0 -47
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +0 -162
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +0 -104
- data/lib/files.com/models/two_factor_authentication_method.rb +0 -250
- data/lib/files.com/models/warning.rb +0 -38
- data/lib/files.com/models/webauthn_sign_request.rb +0 -17
- data/lib/files.com/models/zip_download.rb +0 -73
- data/lib/files.com/models/zip_download_file.rb +0 -111
- data/lib/files.com/models/zip_download_files.rb +0 -42
data/docs/remote_server.md
CHANGED
|
@@ -41,7 +41,6 @@
|
|
|
41
41
|
"wasabi_bucket": "my-bucket",
|
|
42
42
|
"wasabi_region": "us-west-1",
|
|
43
43
|
"wasabi_access_key": "example",
|
|
44
|
-
"auth_setup_link": "auth/:provider",
|
|
45
44
|
"auth_status": "in_setup",
|
|
46
45
|
"auth_account_name": "me@example.com",
|
|
47
46
|
"one_drive_account_type": "personal",
|
|
@@ -117,7 +116,6 @@
|
|
|
117
116
|
* `wasabi_bucket` (string): Wasabi: Bucket name
|
|
118
117
|
* `wasabi_region` (string): Wasabi: Region
|
|
119
118
|
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
120
|
-
* `auth_setup_link` (string): Returns link to login with an Oauth provider
|
|
121
119
|
* `auth_status` (string): Either `in_setup` or `complete`
|
|
122
120
|
* `auth_account_name` (string): Describes the authorized account
|
|
123
121
|
* `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
|
|
@@ -192,19 +190,6 @@ Files::RemoteServer.list
|
|
|
192
190
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
|
|
193
191
|
|
|
194
192
|
|
|
195
|
-
---
|
|
196
|
-
|
|
197
|
-
## ping_agent Remote Server
|
|
198
|
-
|
|
199
|
-
```
|
|
200
|
-
Files::RemoteServer.find_ping_agent(id)
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
### Parameters
|
|
204
|
-
|
|
205
|
-
* `id` (int64): Required - Remote Server ID.
|
|
206
|
-
|
|
207
|
-
|
|
208
193
|
---
|
|
209
194
|
|
|
210
195
|
## Show Remote Server
|
|
@@ -394,53 +379,6 @@ Files::RemoteServer.agent_push_update(id)
|
|
|
394
379
|
* `id` (int64): Required - Remote Server ID.
|
|
395
380
|
|
|
396
381
|
|
|
397
|
-
---
|
|
398
|
-
|
|
399
|
-
## Disconnect a Files Agent Proxy
|
|
400
|
-
|
|
401
|
-
```
|
|
402
|
-
Files::RemoteServer.disconnect_agent(id,
|
|
403
|
-
proxy_url: "",
|
|
404
|
-
proxy_host_header: ""
|
|
405
|
-
)
|
|
406
|
-
```
|
|
407
|
-
|
|
408
|
-
### Parameters
|
|
409
|
-
|
|
410
|
-
* `id` (int64): Required - Remote Server ID.
|
|
411
|
-
* `proxy_url` (string): Files Agent Proxy URL
|
|
412
|
-
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
---
|
|
416
|
-
|
|
417
|
-
## Authenticate a Files Agent Proxy
|
|
418
|
-
|
|
419
|
-
```
|
|
420
|
-
Files::RemoteServer.authenticate_agent(id,
|
|
421
|
-
proxy_registration_refresh: false,
|
|
422
|
-
downstream_proxy_port: 1,
|
|
423
|
-
supports_push_updates: false
|
|
424
|
-
)
|
|
425
|
-
```
|
|
426
|
-
|
|
427
|
-
### Parameters
|
|
428
|
-
|
|
429
|
-
* `id` (int64): Required - Remote Server ID.
|
|
430
|
-
* `signed_nonce` (string): Signed nonce
|
|
431
|
-
* `proxy_registration_refresh` (boolean): Proxy is refreshing an already validated agent registration
|
|
432
|
-
* `agent_version` (string): Agent version
|
|
433
|
-
* `peer_id` (string): Peer ID
|
|
434
|
-
* `proxy_url` (string): Files Agent Proxy URL
|
|
435
|
-
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
436
|
-
* `root` (string): Agent local root path
|
|
437
|
-
* `agent_hostname` (string): Agent local hostname used for system identification
|
|
438
|
-
* `downstream_proxy_port` (int64): Agent downstream proxy port
|
|
439
|
-
* `agent_platform` (string): Agent Platform (OS/Architecture)
|
|
440
|
-
* `permission_set` (string): Permission set
|
|
441
|
-
* `supports_push_updates` (boolean): Agent supports push updates
|
|
442
|
-
|
|
443
|
-
|
|
444
382
|
---
|
|
445
383
|
|
|
446
384
|
## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
|
|
@@ -477,126 +415,6 @@ Files::RemoteServer.configuration_file(id,
|
|
|
477
415
|
* `subdomain` (string): Files.com subdomain site name
|
|
478
416
|
|
|
479
417
|
|
|
480
|
-
---
|
|
481
|
-
|
|
482
|
-
## Create an export CSV of Remote Server resources
|
|
483
|
-
|
|
484
|
-
```
|
|
485
|
-
Files::RemoteServer.create_export
|
|
486
|
-
```
|
|
487
|
-
|
|
488
|
-
### Parameters
|
|
489
|
-
|
|
490
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
|
|
491
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `workspace_id`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ workspace_id, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]`, `[ linode_bucket, name ]`, `[ workspace_id, server_type ]` or `[ workspace_id, server_type, name ]`.
|
|
492
|
-
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
---
|
|
496
|
-
|
|
497
|
-
## list_for_testing Remote Server
|
|
498
|
-
|
|
499
|
-
```
|
|
500
|
-
Files::RemoteServer.list_for_testing(
|
|
501
|
-
azure_blob_storage_hierarchical_namespace: false,
|
|
502
|
-
dropbox_teams: false,
|
|
503
|
-
enable_dedicated_ips: false,
|
|
504
|
-
outbound_agent_id: 1,
|
|
505
|
-
max_connections: 1,
|
|
506
|
-
pin_to_site_region: false,
|
|
507
|
-
port: 1,
|
|
508
|
-
remote_server_id: 1,
|
|
509
|
-
remote_server_credential_id: 1,
|
|
510
|
-
reset_authentication: false,
|
|
511
|
-
s3_assume_role_duration_seconds: 1,
|
|
512
|
-
s3_compatible_virtual_hosted_style: false,
|
|
513
|
-
workspace_id: 1
|
|
514
|
-
)
|
|
515
|
-
```
|
|
516
|
-
|
|
517
|
-
### Parameters
|
|
518
|
-
|
|
519
|
-
* `aws_access_key` (string): AWS: Access Key
|
|
520
|
-
* `aws_secret_key` (string): AWS: Secret Key
|
|
521
|
-
* `azure_blob_storage_access_key` (string): Azure Blob Storage: Secret Key
|
|
522
|
-
* `azure_blob_storage_account` (string):
|
|
523
|
-
* `azure_blob_storage_container` (string):
|
|
524
|
-
* `azure_blob_storage_dns_suffix` (string):
|
|
525
|
-
* `azure_blob_storage_hierarchical_namespace` (boolean):
|
|
526
|
-
* `azure_blob_storage_sas_token` (string): Azure Blob Storage: Shared Access Signature (SAS) token
|
|
527
|
-
* `azure_files_storage_access_key` (string): Azure Files: Access Key
|
|
528
|
-
* `azure_files_storage_account` (string):
|
|
529
|
-
* `azure_files_storage_dns_suffix` (string):
|
|
530
|
-
* `azure_files_storage_sas_token` (string): Azure Files: Shared Access Signature (SAS) token
|
|
531
|
-
* `azure_files_storage_share_name` (string):
|
|
532
|
-
* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage: applicationKey
|
|
533
|
-
* `backblaze_b2_bucket` (string):
|
|
534
|
-
* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage: keyID
|
|
535
|
-
* `backblaze_b2_s3_endpoint` (string):
|
|
536
|
-
* `buffer_uploads` (string): If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
|
|
537
|
-
* `cloudflare_access_key` (string): Cloudflare: Access Key
|
|
538
|
-
* `cloudflare_bucket` (string):
|
|
539
|
-
* `cloudflare_endpoint` (string):
|
|
540
|
-
* `cloudflare_secret_key` (string): Cloudflare: Secret Key
|
|
541
|
-
* `dropbox_teams` (boolean):
|
|
542
|
-
* `upload_staging_path` (string): Upload staging path
|
|
543
|
-
* `enable_dedicated_ips` (boolean):
|
|
544
|
-
* `filebase_access_key` (string): Filebase: Access Key
|
|
545
|
-
* `filebase_bucket` (string):
|
|
546
|
-
* `filebase_secret_key` (string): Filebase: Secret Key
|
|
547
|
-
* `files_api_key` (string): Files.com direct link: API key used once to pair the remote server.
|
|
548
|
-
* `files_agent_api_token` (string):
|
|
549
|
-
* `files_agent_public_key` (string):
|
|
550
|
-
* `files_agent_root` (string):
|
|
551
|
-
* `files_agent_version` (string):
|
|
552
|
-
* `outbound_agent_id` (int64): Route traffic to outbound on a files-agent
|
|
553
|
-
* `google_cloud_storage_authentication_method` (string): Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
|
|
554
|
-
* `google_cloud_storage_bucket` (string):
|
|
555
|
-
* `google_cloud_storage_credentials_json` (string): Google Cloud Storage: A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
556
|
-
* `google_cloud_storage_oauth_scope` (string): Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
|
|
557
|
-
* `google_cloud_storage_project_id` (string):
|
|
558
|
-
* `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible access key
|
|
559
|
-
* `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
|
|
560
|
-
* `hostname` (string):
|
|
561
|
-
* `linode_access_key` (string): Linode: access key
|
|
562
|
-
* `linode_bucket` (string):
|
|
563
|
-
* `linode_region` (string):
|
|
564
|
-
* `linode_secret_key` (string): Linode: secret key
|
|
565
|
-
* `max_connections` (int64):
|
|
566
|
-
* `name` (string):
|
|
567
|
-
* `one_drive_account_type` (string):
|
|
568
|
-
* `password` (string): Password, if needed
|
|
569
|
-
* `pin_to_site_region` (boolean): Pin to site region?
|
|
570
|
-
* `port` (int64):
|
|
571
|
-
* `private_key_passphrase` (string): Passphrase for private key, if needed
|
|
572
|
-
* `private_key` (string): Private key if needed.
|
|
573
|
-
* `remote_server_id` (int64): Remote Server ID
|
|
574
|
-
* `remote_server_credential_id` (int64): Remote Server Credential ID
|
|
575
|
-
* `reset_authentication` (boolean): Reset authenticated account?
|
|
576
|
-
* `root` (string): Remote path to list
|
|
577
|
-
* `s3_assume_role_arn` (string):
|
|
578
|
-
* `s3_assume_role_duration_seconds` (int64):
|
|
579
|
-
* `s3_bucket` (string):
|
|
580
|
-
* `s3_compatible_access_key` (string):
|
|
581
|
-
* `s3_compatible_bucket` (string):
|
|
582
|
-
* `s3_compatible_endpoint` (string):
|
|
583
|
-
* `s3_compatible_region` (string):
|
|
584
|
-
* `s3_compatible_virtual_hosted_style` (boolean):
|
|
585
|
-
* `s3_compatible_secret_key` (string):
|
|
586
|
-
* `s3_region` (string):
|
|
587
|
-
* `server_certificate` (string):
|
|
588
|
-
* `server_host_key` (string):
|
|
589
|
-
* `server_type` (string):
|
|
590
|
-
* `ssl_certificate` (string): SSL client certificate.
|
|
591
|
-
* `ssl` (string):
|
|
592
|
-
* `username` (string):
|
|
593
|
-
* `wasabi_access_key` (string): Wasabi: Access Key
|
|
594
|
-
* `wasabi_bucket` (string):
|
|
595
|
-
* `wasabi_region` (string):
|
|
596
|
-
* `wasabi_secret_key` (string): Wasabi Secret Key
|
|
597
|
-
* `workspace_id` (int64): Workspace ID (0 for default workspace)
|
|
598
|
-
|
|
599
|
-
|
|
600
418
|
---
|
|
601
419
|
|
|
602
420
|
## Update Remote Server
|
|
@@ -774,57 +592,6 @@ remote_server.agent_push_update
|
|
|
774
592
|
* `id` (int64): Required - Remote Server ID.
|
|
775
593
|
|
|
776
594
|
|
|
777
|
-
---
|
|
778
|
-
|
|
779
|
-
## Disconnect a Files Agent Proxy
|
|
780
|
-
|
|
781
|
-
```
|
|
782
|
-
remote_server = Files::RemoteServer.find(id)
|
|
783
|
-
|
|
784
|
-
remote_server.disconnect_agent(
|
|
785
|
-
proxy_url: "",
|
|
786
|
-
proxy_host_header: ""
|
|
787
|
-
)
|
|
788
|
-
```
|
|
789
|
-
|
|
790
|
-
### Parameters
|
|
791
|
-
|
|
792
|
-
* `id` (int64): Required - Remote Server ID.
|
|
793
|
-
* `proxy_url` (string): Files Agent Proxy URL
|
|
794
|
-
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
---
|
|
798
|
-
|
|
799
|
-
## Authenticate a Files Agent Proxy
|
|
800
|
-
|
|
801
|
-
```
|
|
802
|
-
remote_server = Files::RemoteServer.find(id)
|
|
803
|
-
|
|
804
|
-
remote_server.authenticate_agent(
|
|
805
|
-
proxy_registration_refresh: false,
|
|
806
|
-
downstream_proxy_port: 1,
|
|
807
|
-
supports_push_updates: false
|
|
808
|
-
)
|
|
809
|
-
```
|
|
810
|
-
|
|
811
|
-
### Parameters
|
|
812
|
-
|
|
813
|
-
* `id` (int64): Required - Remote Server ID.
|
|
814
|
-
* `signed_nonce` (string): Signed nonce
|
|
815
|
-
* `proxy_registration_refresh` (boolean): Proxy is refreshing an already validated agent registration
|
|
816
|
-
* `agent_version` (string): Agent version
|
|
817
|
-
* `peer_id` (string): Peer ID
|
|
818
|
-
* `proxy_url` (string): Files Agent Proxy URL
|
|
819
|
-
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
820
|
-
* `root` (string): Agent local root path
|
|
821
|
-
* `agent_hostname` (string): Agent local hostname used for system identification
|
|
822
|
-
* `downstream_proxy_port` (int64): Agent downstream proxy port
|
|
823
|
-
* `agent_platform` (string): Agent Platform (OS/Architecture)
|
|
824
|
-
* `permission_set` (string): Permission set
|
|
825
|
-
* `supports_push_updates` (boolean): Agent supports push updates
|
|
826
|
-
|
|
827
|
-
|
|
828
595
|
---
|
|
829
596
|
|
|
830
597
|
## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
|
|
@@ -149,21 +149,6 @@ Files::RemoteServerCredential.create(
|
|
|
149
149
|
* `copy_values_from_credential_id` (int64): ID of Remote Server Credential to copy omitted values from.
|
|
150
150
|
|
|
151
151
|
|
|
152
|
-
---
|
|
153
|
-
|
|
154
|
-
## Create an export CSV of Remote Server Credential resources
|
|
155
|
-
|
|
156
|
-
```
|
|
157
|
-
Files::RemoteServerCredential.create_export
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
### Parameters
|
|
161
|
-
|
|
162
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `id`.
|
|
163
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id` and `name`. Valid field combinations are `[ workspace_id, name ]`.
|
|
164
|
-
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
165
|
-
|
|
166
|
-
|
|
167
152
|
---
|
|
168
153
|
|
|
169
154
|
## Update Remote Server Credential
|
data/docs/request.md
CHANGED
|
@@ -81,23 +81,6 @@ Files::Request.create(
|
|
|
81
81
|
* `group_ids` (string): A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
|
|
82
82
|
|
|
83
83
|
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
## Create an export CSV of Request resources
|
|
87
|
-
|
|
88
|
-
```
|
|
89
|
-
Files::Request.create_export(
|
|
90
|
-
mine: false
|
|
91
|
-
)
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
### Parameters
|
|
95
|
-
|
|
96
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
97
|
-
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
|
98
|
-
* `path` (string): Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
|
|
99
|
-
|
|
100
|
-
|
|
101
84
|
---
|
|
102
85
|
|
|
103
86
|
## Delete Request
|
data/docs/restore.md
CHANGED
|
@@ -96,17 +96,3 @@ Files::Restore.create(
|
|
|
96
96
|
* `restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
|
|
97
97
|
* `update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
|
|
98
98
|
* `workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
---
|
|
102
|
-
|
|
103
|
-
## Create an export CSV of Restore resources
|
|
104
|
-
|
|
105
|
-
```
|
|
106
|
-
Files::Restore.create_export
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
### Parameters
|
|
110
|
-
|
|
111
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
|
|
112
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `restoration_type`.
|
data/docs/scheduled_export.md
CHANGED
|
@@ -122,21 +122,6 @@ Files::ScheduledExport.create(
|
|
|
122
122
|
* `holiday_region` (string): Optional holiday region used by schedule-driven exports.
|
|
123
123
|
|
|
124
124
|
|
|
125
|
-
---
|
|
126
|
-
|
|
127
|
-
## Create an export CSV of Scheduled Export resources
|
|
128
|
-
|
|
129
|
-
```
|
|
130
|
-
Files::ScheduledExport.create_export
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### Parameters
|
|
134
|
-
|
|
135
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `export_type` or `disabled`.
|
|
136
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled` and `export_type`.
|
|
137
|
-
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
|
|
138
|
-
|
|
139
|
-
|
|
140
125
|
---
|
|
141
126
|
|
|
142
127
|
## Update Scheduled Export
|
data/docs/scim_log.md
CHANGED
|
@@ -51,16 +51,3 @@ Files::ScimLog.find(id)
|
|
|
51
51
|
### Parameters
|
|
52
52
|
|
|
53
53
|
* `id` (int64): Required - Scim Log ID.
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## Create an export CSV of Scim Log resources
|
|
59
|
-
|
|
60
|
-
```
|
|
61
|
-
Files::ScimLog.create_export
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Parameters
|
|
65
|
-
|
|
66
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
data/docs/session.md
CHANGED
|
@@ -6,86 +6,17 @@
|
|
|
6
6
|
{
|
|
7
7
|
"id": "60525f92e859c4c3d74cb02fd176b1525901b525",
|
|
8
8
|
"language": "en",
|
|
9
|
-
"aws_secret_key": "example",
|
|
10
|
-
"ai_assistant_personality_id": 1,
|
|
11
|
-
"ai_assistant_personality_system_prompt": "example",
|
|
12
|
-
"login_token": "@tok-randomcode",
|
|
13
|
-
"login_token_domain": "https://mysite.files.com",
|
|
14
|
-
"default_workspace_id": 1,
|
|
15
|
-
"max_dir_listing_size": 1,
|
|
16
|
-
"multiple_regions": true,
|
|
17
9
|
"read_only": true,
|
|
18
|
-
"
|
|
19
|
-
"home_path": "example",
|
|
20
|
-
"sftp_insecure_ciphers": true,
|
|
21
|
-
"site_id": 1,
|
|
22
|
-
"ssl_required": true,
|
|
23
|
-
"timeout_at": "2000-01-01T01:00:00Z",
|
|
24
|
-
"trusted": true,
|
|
25
|
-
"two_factor_setup_needed": true,
|
|
26
|
-
"allowed_2fa_method_sms": true,
|
|
27
|
-
"allowed_2fa_method_totp": true,
|
|
28
|
-
"allowed_2fa_method_webauthn": true,
|
|
29
|
-
"allowed_2fa_method_yubi": true,
|
|
30
|
-
"calculate_file_checksums_crc32": true,
|
|
31
|
-
"calculate_file_checksums_md5": true,
|
|
32
|
-
"calculate_file_checksums_sha1": true,
|
|
33
|
-
"calculate_file_checksums_sha256": true,
|
|
34
|
-
"legacy_checksums_mode": true,
|
|
35
|
-
"finalize_partial_uploads": true,
|
|
36
|
-
"use_provided_modified_at": true,
|
|
37
|
-
"windows_mode_ftp": true,
|
|
38
|
-
"user_belongs_to_parent_site": true,
|
|
39
|
-
"impersonator_user_id": 1
|
|
10
|
+
"sftp_insecure_ciphers": true
|
|
40
11
|
}
|
|
41
12
|
```
|
|
42
13
|
|
|
43
14
|
* `id` (string): Session ID
|
|
44
15
|
* `language` (string): Session language
|
|
45
|
-
* `aws_secret_key` (string): AWS Secret Key for validating AWS-style signatures in the Inbound S3 endpoint.
|
|
46
|
-
* `ai_assistant_personality_id` (int64): AI Assistant Personality ID for the in-app AI Assistant.
|
|
47
|
-
* `ai_assistant_personality_system_prompt` (string): System prompt for the in-app AI Assistant.
|
|
48
|
-
* `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`.
|
|
49
|
-
* `login_token_domain` (string): Domain to use with `login_token`.
|
|
50
|
-
* `default_workspace_id` (int64): Workspace ID the user should land in by default when more than one Workspace is available.
|
|
51
|
-
* `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.
|
|
52
|
-
* `multiple_regions` (boolean): Can access multiple regions?
|
|
53
16
|
* `read_only` (boolean): Is this session read only?
|
|
54
|
-
* `root_path` (string): Root path to restrict the user's session to.
|
|
55
|
-
* `home_path` (string): Initial path to start the user's session in.
|
|
56
17
|
* `sftp_insecure_ciphers` (boolean): 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.)
|
|
57
|
-
* `site_id` (int64): Site ID
|
|
58
|
-
* `ssl_required` (boolean): Is SSL required for this user? (If so, ensure all your communications with this user use SSL.)
|
|
59
|
-
* `timeout_at` (date-time): Session timeout datetime
|
|
60
|
-
* `trusted` (boolean): Can this session tolerate IP and User-Agent mismatches?
|
|
61
|
-
* `two_factor_setup_needed` (boolean): If true, this user needs to add a Two Factor Authentication method before performing any further actions.
|
|
62
|
-
* `allowed_2fa_method_sms` (boolean): Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
|
|
63
|
-
* `allowed_2fa_method_totp` (boolean): Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
|
|
64
|
-
* `allowed_2fa_method_webauthn` (boolean): Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
|
|
65
|
-
* `allowed_2fa_method_yubi` (boolean): Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
|
|
66
|
-
* `calculate_file_checksums_crc32` (boolean): Calculate CRC32 checksum for incoming files?
|
|
67
|
-
* `calculate_file_checksums_md5` (boolean): Calculate MD5 checksum for incoming files?
|
|
68
|
-
* `calculate_file_checksums_sha1` (boolean): Calculate SHA1 checksum for incoming files?
|
|
69
|
-
* `calculate_file_checksums_sha256` (boolean): Calculate SHA256 checksum for incoming files?
|
|
70
|
-
* `legacy_checksums_mode` (boolean): Use legacy checksums mode?
|
|
71
|
-
* `finalize_partial_uploads` (boolean): Finalize partial SFTP uploads?
|
|
72
|
-
* `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.
|
|
73
|
-
* `windows_mode_ftp` (boolean): Does this user want to use Windows line-ending emulation? (CR vs CRLF)
|
|
74
|
-
* `user_belongs_to_parent_site` (boolean):
|
|
75
|
-
* `impersonator_user_id` (int64): User ID of the Site Admin who initiated a Read-Only session impersonating this session's user
|
|
76
18
|
* `username` (string): Username to sign in as
|
|
77
19
|
* `password` (string): Password for sign in
|
|
78
|
-
* `aws_access_key_id` (string): AWS Access Key ID for signing in with AWS credentials
|
|
79
|
-
* `change_password` (string):
|
|
80
|
-
* `change_password_confirmation` (string):
|
|
81
|
-
* `interface` (string):
|
|
82
|
-
* `ssh_client_identification` (string):
|
|
83
|
-
* `locale` (string):
|
|
84
|
-
* `no_cookie` (boolean):
|
|
85
|
-
* `oauth_provider` (string):
|
|
86
|
-
* `oauth_label` (string):
|
|
87
|
-
* `oauth_code` (string):
|
|
88
|
-
* `oauth_state` (string):
|
|
89
20
|
* `otp` (string): If this user has a 2FA device, provide its OTP or code here.
|
|
90
21
|
* `partial_session_id` (string): Identifier for a partially-completed login
|
|
91
22
|
|
|
@@ -98,8 +29,6 @@
|
|
|
98
29
|
Files::Session.create(
|
|
99
30
|
username: "username",
|
|
100
31
|
password: "password",
|
|
101
|
-
aws_access_key_id: "AKIAIOSFODNN7EXAMPLE",
|
|
102
|
-
no_cookie: false,
|
|
103
32
|
otp: "123456"
|
|
104
33
|
)
|
|
105
34
|
```
|
|
@@ -108,170 +37,10 @@ Files::Session.create(
|
|
|
108
37
|
|
|
109
38
|
* `username` (string): Username to sign in as
|
|
110
39
|
* `password` (string): Password for sign in
|
|
111
|
-
* `aws_access_key_id` (string): AWS Access Key ID for signing in with AWS credentials
|
|
112
|
-
* `change_password` (string):
|
|
113
|
-
* `change_password_confirmation` (string):
|
|
114
|
-
* `interface` (string):
|
|
115
|
-
* `ssh_client_identification` (string):
|
|
116
|
-
* `locale` (string):
|
|
117
|
-
* `no_cookie` (boolean):
|
|
118
|
-
* `oauth_provider` (string):
|
|
119
|
-
* `oauth_label` (string):
|
|
120
|
-
* `oauth_code` (string):
|
|
121
|
-
* `oauth_state` (string):
|
|
122
40
|
* `otp` (string): If this user has a 2FA device, provide its OTP or code here.
|
|
123
41
|
* `partial_session_id` (string): Identifier for a partially-completed login
|
|
124
42
|
|
|
125
43
|
|
|
126
|
-
---
|
|
127
|
-
|
|
128
|
-
## Login the current user to a child site
|
|
129
|
-
|
|
130
|
-
```
|
|
131
|
-
Files::Session.subdomain(
|
|
132
|
-
subdomain: "child_site"
|
|
133
|
-
)
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Parameters
|
|
137
|
-
|
|
138
|
-
* `subdomain` (string): Required - Site subdomain to login to
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
## Site Admins only: Create a read-only session representing another user
|
|
144
|
-
|
|
145
|
-
```
|
|
146
|
-
Files::Session.as_user(
|
|
147
|
-
user_id: "2"
|
|
148
|
-
)
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
### Parameters
|
|
152
|
-
|
|
153
|
-
* `user_id` (string): Required - User id to login as
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
---
|
|
157
|
-
|
|
158
|
-
## Create trusted session from an existing session
|
|
159
|
-
|
|
160
|
-
```
|
|
161
|
-
Files::Session.trusted(
|
|
162
|
-
session_id: "60525f92e859c4c3d74cb02fd176b1525901b525"
|
|
163
|
-
)
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
### Parameters
|
|
167
|
-
|
|
168
|
-
* `session_id` (string): Required - Session ID to convert to a trusted session
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
## Reset password given a password reset code
|
|
174
|
-
|
|
175
|
-
```
|
|
176
|
-
Files::Session.forgot_reset(
|
|
177
|
-
code: "abc123",
|
|
178
|
-
password: "password",
|
|
179
|
-
confirm_password: "password",
|
|
180
|
-
interface: "web",
|
|
181
|
-
locale: "en",
|
|
182
|
-
otp: "123456"
|
|
183
|
-
)
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
### Parameters
|
|
187
|
-
|
|
188
|
-
* `code` (string): Required -
|
|
189
|
-
* `password` (string): Required -
|
|
190
|
-
* `confirm_password` (string):
|
|
191
|
-
* `interface` (string):
|
|
192
|
-
* `locale` (string):
|
|
193
|
-
* `otp` (string):
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
---
|
|
197
|
-
|
|
198
|
-
## Validate password reset code
|
|
199
|
-
|
|
200
|
-
```
|
|
201
|
-
Files::Session.forgot_validate(
|
|
202
|
-
code: "abc123"
|
|
203
|
-
)
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
### Parameters
|
|
207
|
-
|
|
208
|
-
* `code` (string): Required -
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
---
|
|
212
|
-
|
|
213
|
-
## Initiate a password reset process given an email address or username
|
|
214
|
-
|
|
215
|
-
```
|
|
216
|
-
Files::Session.forgot(
|
|
217
|
-
email: "johndoe@gmail.com"
|
|
218
|
-
)
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
### Parameters
|
|
222
|
-
|
|
223
|
-
* `email` (string):
|
|
224
|
-
* `username` (string):
|
|
225
|
-
* `username_or_email` (string):
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
---
|
|
229
|
-
|
|
230
|
-
## Create Public Hosting session pairing key
|
|
231
|
-
|
|
232
|
-
```
|
|
233
|
-
Files::Session.public_hosting(
|
|
234
|
-
return_to: "return_to"
|
|
235
|
-
)
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
### Parameters
|
|
239
|
-
|
|
240
|
-
* `return_to` (string): Required - Public Hosting URL to return to after authentication
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
---
|
|
244
|
-
|
|
245
|
-
## Create long lived session (API Key) from Pairing Key
|
|
246
|
-
|
|
247
|
-
```
|
|
248
|
-
Files::Session.pairing_key(key)
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
### Parameters
|
|
252
|
-
|
|
253
|
-
* `key` (string): Required - The pairing key to reserve for login. Cannot be reused
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
---
|
|
257
|
-
|
|
258
|
-
## Begin new session via Oauth
|
|
259
|
-
|
|
260
|
-
```
|
|
261
|
-
Files::Session.oauth(
|
|
262
|
-
provider: "okta",
|
|
263
|
-
label: "My Corporate SSO Provider"
|
|
264
|
-
)
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
### Parameters
|
|
268
|
-
|
|
269
|
-
* `provider` (string): Required -
|
|
270
|
-
* `label` (string):
|
|
271
|
-
* `state` (string):
|
|
272
|
-
* `host` (string):
|
|
273
|
-
|
|
274
|
-
|
|
275
44
|
---
|
|
276
45
|
|
|
277
46
|
## Delete user session (log out)
|
data/docs/settings_change.md
CHANGED
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
"example"
|
|
10
10
|
],
|
|
11
11
|
"created_at": "2000-01-01T01:00:00Z",
|
|
12
|
-
"log_type": "example",
|
|
13
12
|
"user_id": 1,
|
|
14
13
|
"user_is_files_support": true,
|
|
15
14
|
"user_is_from_parent_site": true,
|
|
@@ -20,7 +19,6 @@
|
|
|
20
19
|
* `api_key_id` (int64): The API key id responsible for this change.
|
|
21
20
|
* `changes` (array(string)): Markdown-formatted change messages.
|
|
22
21
|
* `created_at` (date-time): The time this change was made.
|
|
23
|
-
* `log_type` (string): Log Type.
|
|
24
22
|
* `user_id` (int64): The user id responsible for this change.
|
|
25
23
|
* `user_is_files_support` (boolean): true if this change was performed by Files.com support.
|
|
26
24
|
* `user_is_from_parent_site` (boolean): true if this change was performed by a user on a parent site.
|
|
@@ -41,17 +39,3 @@ Files::SettingsChange.list
|
|
|
41
39
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
42
40
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `api_key_id` or `user_id`.
|
|
43
41
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
## Create an export CSV of Settings Change resources
|
|
49
|
-
|
|
50
|
-
```
|
|
51
|
-
Files::SettingsChange.create_export
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### Parameters
|
|
55
|
-
|
|
56
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `api_key_id` or `user_id`.
|
|
57
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|