files.com 1.1.671 → 1.1.672
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 +0 -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/version.rb +1 -1
- data/lib/files.com.rb +0 -59
- metadata +1 -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/sso_strategy.md
CHANGED
|
@@ -111,13 +111,6 @@
|
|
|
111
111
|
* `ldap_type` (string): LDAP server type
|
|
112
112
|
* `ldap_username` (string): Username for signing in to LDAP server.
|
|
113
113
|
* `ldap_username_field` (string): LDAP username field
|
|
114
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
|
115
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
|
116
|
-
* `ldap_password` (string): Password for signing in to LDAP server.
|
|
117
|
-
* `logo_delete` (boolean): If true, the logo will be deleted.
|
|
118
|
-
* `logo_file` (file): A logo to display on the login page.
|
|
119
|
-
* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
|
|
120
|
-
* `scim_password` (string): SCIM password applicable to basic authentication.
|
|
121
114
|
|
|
122
115
|
|
|
123
116
|
---
|
|
@@ -148,124 +141,6 @@ Files::SsoStrategy.find(id)
|
|
|
148
141
|
* `id` (int64): Required - Sso Strategy ID.
|
|
149
142
|
|
|
150
143
|
|
|
151
|
-
---
|
|
152
|
-
|
|
153
|
-
## Create SSO Strategy
|
|
154
|
-
|
|
155
|
-
```
|
|
156
|
-
Files::SsoStrategy.create(
|
|
157
|
-
client_id: "[client id]",
|
|
158
|
-
client_secret: "[client secret]",
|
|
159
|
-
logo_delete: false,
|
|
160
|
-
reset_scim_oauth_access_token: false,
|
|
161
|
-
deprovision_behavior: "disable",
|
|
162
|
-
deprovision_groups: false,
|
|
163
|
-
deprovision_users: false,
|
|
164
|
-
display_on_login_page: true,
|
|
165
|
-
enabled: true,
|
|
166
|
-
label: "My Corporate SSO Provider",
|
|
167
|
-
ldap_base_dn: "example",
|
|
168
|
-
ldap_domain: "mysite.com",
|
|
169
|
-
ldap_host: "ldap.site.com",
|
|
170
|
-
ldap_host_2: "ldap2.site.com",
|
|
171
|
-
ldap_host_3: "ldap3.site.com",
|
|
172
|
-
ldap_port: 1,
|
|
173
|
-
ldap_provisioning_enabled: true,
|
|
174
|
-
ldap_secure: true,
|
|
175
|
-
ldap_type: "active_directory",
|
|
176
|
-
ldap_username: "[ldap username]",
|
|
177
|
-
ldap_username_field: "sAMAccountName",
|
|
178
|
-
protocol: "oauth2",
|
|
179
|
-
provider: "okta",
|
|
180
|
-
provider_identifier: "provider_identifier",
|
|
181
|
-
provision_company: "ACME Corp.",
|
|
182
|
-
provision_dav_permission: true,
|
|
183
|
-
provision_email_signup_groups: "Employees",
|
|
184
|
-
provision_filesystem_layout: "integration_centric",
|
|
185
|
-
provision_ftp_permission: true,
|
|
186
|
-
provision_group_admin_groups: "Employees",
|
|
187
|
-
provision_group_default: "Employees",
|
|
188
|
-
provision_group_exclusion: "Employees",
|
|
189
|
-
provision_group_inclusion: "Employees",
|
|
190
|
-
provision_group_required: "example",
|
|
191
|
-
provision_groups: false,
|
|
192
|
-
provision_readonly_site_admin_groups: "Employees",
|
|
193
|
-
provision_require_2fa: "always_require",
|
|
194
|
-
provision_sftp_permission: true,
|
|
195
|
-
provision_site_admin_groups: "Employees",
|
|
196
|
-
provision_time_zone: "Eastern Time (US & Canada)",
|
|
197
|
-
provision_users: false,
|
|
198
|
-
saml_provider_cert_fingerprint: "example",
|
|
199
|
-
saml_provider_issuer_url: "example",
|
|
200
|
-
saml_provider_metadata_content: "example",
|
|
201
|
-
saml_provider_metadata_url: "example",
|
|
202
|
-
saml_provider_slo_target_url: "example",
|
|
203
|
-
saml_provider_sso_target_url: "example",
|
|
204
|
-
scim_authentication_method: "example",
|
|
205
|
-
scim_oauth_access_token_expires_at: "example",
|
|
206
|
-
scim_username: "example",
|
|
207
|
-
subdomain: "subdomain"
|
|
208
|
-
)
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
### Parameters
|
|
212
|
-
|
|
213
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
|
214
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
|
215
|
-
* `ldap_password` (string): Password for signing in to LDAP server.
|
|
216
|
-
* `logo_delete` (boolean): If true, the logo will be deleted.
|
|
217
|
-
* `logo_file` (file): A logo to display on the login page.
|
|
218
|
-
* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
|
|
219
|
-
* `scim_password` (string): SCIM password applicable to basic authentication.
|
|
220
|
-
* `deprovision_behavior` (string): Method used for deprovisioning users.
|
|
221
|
-
* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
|
|
222
|
-
* `deprovision_users` (boolean): Auto-deprovision users?
|
|
223
|
-
* `display_on_login_page` (boolean): Should this strategy be displayed on the login page?
|
|
224
|
-
* `enabled` (boolean): Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
225
|
-
* `label` (string): Custom label for the SSO provider on the login page.
|
|
226
|
-
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
227
|
-
* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
|
|
228
|
-
* `ldap_host` (string): LDAP host
|
|
229
|
-
* `ldap_host_2` (string): LDAP backup host
|
|
230
|
-
* `ldap_host_3` (string): LDAP backup host
|
|
231
|
-
* `ldap_port` (int64): LDAP port
|
|
232
|
-
* `ldap_provisioning_enabled` (boolean): Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
233
|
-
* `ldap_secure` (boolean): Use secure LDAP?
|
|
234
|
-
* `ldap_type` (string): LDAP server type
|
|
235
|
-
* `ldap_username` (string): Username for signing in to LDAP server.
|
|
236
|
-
* `ldap_username_field` (string): LDAP username field
|
|
237
|
-
* `protocol` (string): SSO Protocol
|
|
238
|
-
* `provider` (string): Provider name
|
|
239
|
-
* `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
|
|
240
|
-
* `provision_company` (string): Default company for auto provisioned users.
|
|
241
|
-
* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
|
|
242
|
-
* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
243
|
-
* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
|
|
244
|
-
* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
|
|
245
|
-
* `provision_group_admin_groups` (string): Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
246
|
-
* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
247
|
-
* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
248
|
-
* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
249
|
-
* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
250
|
-
* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
|
|
251
|
-
* `provision_readonly_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
252
|
-
* `provision_require_2fa` (string): 2FA required setting for auto provisioned users. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
|
|
253
|
-
* `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
|
|
254
|
-
* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
|
|
255
|
-
* `provision_time_zone` (string): Default time zone for auto provisioned users.
|
|
256
|
-
* `provision_users` (boolean): Auto-provision users?
|
|
257
|
-
* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
258
|
-
* `saml_provider_issuer_url` (string): Identity provider issuer url
|
|
259
|
-
* `saml_provider_metadata_content` (string): Custom identity provider metadata
|
|
260
|
-
* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
|
|
261
|
-
* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
|
|
262
|
-
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
263
|
-
* `scim_authentication_method` (string): SCIM authentication type.
|
|
264
|
-
* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
|
|
265
|
-
* `scim_username` (string): SCIM username.
|
|
266
|
-
* `subdomain` (string): Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
267
|
-
|
|
268
|
-
|
|
269
144
|
---
|
|
270
145
|
|
|
271
146
|
## Synchronize provisioning data with the SSO remote server
|
|
@@ -279,151 +154,6 @@ Files::SsoStrategy.sync(id)
|
|
|
279
154
|
* `id` (int64): Required - Sso Strategy ID.
|
|
280
155
|
|
|
281
156
|
|
|
282
|
-
---
|
|
283
|
-
|
|
284
|
-
## Create an export CSV of SSO Strategy resources
|
|
285
|
-
|
|
286
|
-
```
|
|
287
|
-
Files::SsoStrategy.create_export
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
### Parameters
|
|
291
|
-
|
|
292
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
---
|
|
296
|
-
|
|
297
|
-
## Update SSO Strategy
|
|
298
|
-
|
|
299
|
-
```
|
|
300
|
-
Files::SsoStrategy.update(id,
|
|
301
|
-
client_id: "[client id]",
|
|
302
|
-
client_secret: "[client secret]",
|
|
303
|
-
logo_delete: false,
|
|
304
|
-
reset_scim_oauth_access_token: false,
|
|
305
|
-
deprovision_behavior: "disable",
|
|
306
|
-
deprovision_groups: false,
|
|
307
|
-
deprovision_users: false,
|
|
308
|
-
display_on_login_page: true,
|
|
309
|
-
enabled: true,
|
|
310
|
-
label: "My Corporate SSO Provider",
|
|
311
|
-
ldap_base_dn: "example",
|
|
312
|
-
ldap_domain: "mysite.com",
|
|
313
|
-
ldap_host: "ldap.site.com",
|
|
314
|
-
ldap_host_2: "ldap2.site.com",
|
|
315
|
-
ldap_host_3: "ldap3.site.com",
|
|
316
|
-
ldap_port: 1,
|
|
317
|
-
ldap_provisioning_enabled: true,
|
|
318
|
-
ldap_secure: true,
|
|
319
|
-
ldap_type: "active_directory",
|
|
320
|
-
ldap_username: "[ldap username]",
|
|
321
|
-
ldap_username_field: "sAMAccountName",
|
|
322
|
-
protocol: "oauth2",
|
|
323
|
-
provider: "okta",
|
|
324
|
-
provider_identifier: "provider_identifier",
|
|
325
|
-
provision_company: "ACME Corp.",
|
|
326
|
-
provision_dav_permission: true,
|
|
327
|
-
provision_email_signup_groups: "Employees",
|
|
328
|
-
provision_filesystem_layout: "integration_centric",
|
|
329
|
-
provision_ftp_permission: true,
|
|
330
|
-
provision_group_admin_groups: "Employees",
|
|
331
|
-
provision_group_default: "Employees",
|
|
332
|
-
provision_group_exclusion: "Employees",
|
|
333
|
-
provision_group_inclusion: "Employees",
|
|
334
|
-
provision_group_required: "example",
|
|
335
|
-
provision_groups: false,
|
|
336
|
-
provision_readonly_site_admin_groups: "Employees",
|
|
337
|
-
provision_require_2fa: "always_require",
|
|
338
|
-
provision_sftp_permission: true,
|
|
339
|
-
provision_site_admin_groups: "Employees",
|
|
340
|
-
provision_time_zone: "Eastern Time (US & Canada)",
|
|
341
|
-
provision_users: false,
|
|
342
|
-
saml_provider_cert_fingerprint: "example",
|
|
343
|
-
saml_provider_issuer_url: "example",
|
|
344
|
-
saml_provider_metadata_content: "example",
|
|
345
|
-
saml_provider_metadata_url: "example",
|
|
346
|
-
saml_provider_slo_target_url: "example",
|
|
347
|
-
saml_provider_sso_target_url: "example",
|
|
348
|
-
scim_authentication_method: "example",
|
|
349
|
-
scim_oauth_access_token_expires_at: "example",
|
|
350
|
-
scim_username: "example",
|
|
351
|
-
subdomain: "subdomain"
|
|
352
|
-
)
|
|
353
|
-
```
|
|
354
|
-
|
|
355
|
-
### Parameters
|
|
356
|
-
|
|
357
|
-
* `id` (int64): Required - Sso Strategy ID.
|
|
358
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
|
359
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
|
360
|
-
* `ldap_password` (string): Password for signing in to LDAP server.
|
|
361
|
-
* `logo_delete` (boolean): If true, the logo will be deleted.
|
|
362
|
-
* `logo_file` (file): A logo to display on the login page.
|
|
363
|
-
* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
|
|
364
|
-
* `scim_password` (string): SCIM password applicable to basic authentication.
|
|
365
|
-
* `deprovision_behavior` (string): Method used for deprovisioning users.
|
|
366
|
-
* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
|
|
367
|
-
* `deprovision_users` (boolean): Auto-deprovision users?
|
|
368
|
-
* `display_on_login_page` (boolean): Should this strategy be displayed on the login page?
|
|
369
|
-
* `enabled` (boolean): Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
370
|
-
* `label` (string): Custom label for the SSO provider on the login page.
|
|
371
|
-
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
372
|
-
* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
|
|
373
|
-
* `ldap_host` (string): LDAP host
|
|
374
|
-
* `ldap_host_2` (string): LDAP backup host
|
|
375
|
-
* `ldap_host_3` (string): LDAP backup host
|
|
376
|
-
* `ldap_port` (int64): LDAP port
|
|
377
|
-
* `ldap_provisioning_enabled` (boolean): Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
378
|
-
* `ldap_secure` (boolean): Use secure LDAP?
|
|
379
|
-
* `ldap_type` (string): LDAP server type
|
|
380
|
-
* `ldap_username` (string): Username for signing in to LDAP server.
|
|
381
|
-
* `ldap_username_field` (string): LDAP username field
|
|
382
|
-
* `protocol` (string): SSO Protocol
|
|
383
|
-
* `provider` (string): Provider name
|
|
384
|
-
* `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
|
|
385
|
-
* `provision_company` (string): Default company for auto provisioned users.
|
|
386
|
-
* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
|
|
387
|
-
* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
388
|
-
* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
|
|
389
|
-
* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
|
|
390
|
-
* `provision_group_admin_groups` (string): Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
391
|
-
* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
392
|
-
* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
393
|
-
* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
394
|
-
* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
395
|
-
* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
|
|
396
|
-
* `provision_readonly_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
397
|
-
* `provision_require_2fa` (string): 2FA required setting for auto provisioned users. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
|
|
398
|
-
* `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
|
|
399
|
-
* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
|
|
400
|
-
* `provision_time_zone` (string): Default time zone for auto provisioned users.
|
|
401
|
-
* `provision_users` (boolean): Auto-provision users?
|
|
402
|
-
* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
403
|
-
* `saml_provider_issuer_url` (string): Identity provider issuer url
|
|
404
|
-
* `saml_provider_metadata_content` (string): Custom identity provider metadata
|
|
405
|
-
* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
|
|
406
|
-
* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
|
|
407
|
-
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
408
|
-
* `scim_authentication_method` (string): SCIM authentication type.
|
|
409
|
-
* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
|
|
410
|
-
* `scim_username` (string): SCIM username.
|
|
411
|
-
* `subdomain` (string): Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
---
|
|
415
|
-
|
|
416
|
-
## Delete SSO Strategy
|
|
417
|
-
|
|
418
|
-
```
|
|
419
|
-
Files::SsoStrategy.delete(id)
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
### Parameters
|
|
423
|
-
|
|
424
|
-
* `id` (int64): Required - Sso Strategy ID.
|
|
425
|
-
|
|
426
|
-
|
|
427
157
|
---
|
|
428
158
|
|
|
429
159
|
## Synchronize provisioning data with the SSO remote server
|
|
@@ -437,139 +167,3 @@ sso_strategy.sync
|
|
|
437
167
|
### Parameters
|
|
438
168
|
|
|
439
169
|
* `id` (int64): Required - Sso Strategy ID.
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
---
|
|
443
|
-
|
|
444
|
-
## Update SSO Strategy
|
|
445
|
-
|
|
446
|
-
```
|
|
447
|
-
sso_strategy = Files::SsoStrategy.find(id)
|
|
448
|
-
|
|
449
|
-
sso_strategy.update(
|
|
450
|
-
client_id: "[client id]",
|
|
451
|
-
client_secret: "[client secret]",
|
|
452
|
-
logo_delete: false,
|
|
453
|
-
reset_scim_oauth_access_token: false,
|
|
454
|
-
deprovision_behavior: "disable",
|
|
455
|
-
deprovision_groups: false,
|
|
456
|
-
deprovision_users: false,
|
|
457
|
-
display_on_login_page: true,
|
|
458
|
-
enabled: true,
|
|
459
|
-
label: "My Corporate SSO Provider",
|
|
460
|
-
ldap_base_dn: "example",
|
|
461
|
-
ldap_domain: "mysite.com",
|
|
462
|
-
ldap_host: "ldap.site.com",
|
|
463
|
-
ldap_host_2: "ldap2.site.com",
|
|
464
|
-
ldap_host_3: "ldap3.site.com",
|
|
465
|
-
ldap_port: 1,
|
|
466
|
-
ldap_provisioning_enabled: true,
|
|
467
|
-
ldap_secure: true,
|
|
468
|
-
ldap_type: "active_directory",
|
|
469
|
-
ldap_username: "[ldap username]",
|
|
470
|
-
ldap_username_field: "sAMAccountName",
|
|
471
|
-
protocol: "oauth2",
|
|
472
|
-
provider: "okta",
|
|
473
|
-
provider_identifier: "provider_identifier",
|
|
474
|
-
provision_company: "ACME Corp.",
|
|
475
|
-
provision_dav_permission: true,
|
|
476
|
-
provision_email_signup_groups: "Employees",
|
|
477
|
-
provision_filesystem_layout: "integration_centric",
|
|
478
|
-
provision_ftp_permission: true,
|
|
479
|
-
provision_group_admin_groups: "Employees",
|
|
480
|
-
provision_group_default: "Employees",
|
|
481
|
-
provision_group_exclusion: "Employees",
|
|
482
|
-
provision_group_inclusion: "Employees",
|
|
483
|
-
provision_group_required: "example",
|
|
484
|
-
provision_groups: false,
|
|
485
|
-
provision_readonly_site_admin_groups: "Employees",
|
|
486
|
-
provision_require_2fa: "always_require",
|
|
487
|
-
provision_sftp_permission: true,
|
|
488
|
-
provision_site_admin_groups: "Employees",
|
|
489
|
-
provision_time_zone: "Eastern Time (US & Canada)",
|
|
490
|
-
provision_users: false,
|
|
491
|
-
saml_provider_cert_fingerprint: "example",
|
|
492
|
-
saml_provider_issuer_url: "example",
|
|
493
|
-
saml_provider_metadata_content: "example",
|
|
494
|
-
saml_provider_metadata_url: "example",
|
|
495
|
-
saml_provider_slo_target_url: "example",
|
|
496
|
-
saml_provider_sso_target_url: "example",
|
|
497
|
-
scim_authentication_method: "example",
|
|
498
|
-
scim_oauth_access_token_expires_at: "example",
|
|
499
|
-
scim_username: "example",
|
|
500
|
-
subdomain: "subdomain"
|
|
501
|
-
)
|
|
502
|
-
```
|
|
503
|
-
|
|
504
|
-
### Parameters
|
|
505
|
-
|
|
506
|
-
* `id` (int64): Required - Sso Strategy ID.
|
|
507
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
|
508
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
|
509
|
-
* `ldap_password` (string): Password for signing in to LDAP server.
|
|
510
|
-
* `logo_delete` (boolean): If true, the logo will be deleted.
|
|
511
|
-
* `logo_file` (file): A logo to display on the login page.
|
|
512
|
-
* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
|
|
513
|
-
* `scim_password` (string): SCIM password applicable to basic authentication.
|
|
514
|
-
* `deprovision_behavior` (string): Method used for deprovisioning users.
|
|
515
|
-
* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
|
|
516
|
-
* `deprovision_users` (boolean): Auto-deprovision users?
|
|
517
|
-
* `display_on_login_page` (boolean): Should this strategy be displayed on the login page?
|
|
518
|
-
* `enabled` (boolean): Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
519
|
-
* `label` (string): Custom label for the SSO provider on the login page.
|
|
520
|
-
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
521
|
-
* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
|
|
522
|
-
* `ldap_host` (string): LDAP host
|
|
523
|
-
* `ldap_host_2` (string): LDAP backup host
|
|
524
|
-
* `ldap_host_3` (string): LDAP backup host
|
|
525
|
-
* `ldap_port` (int64): LDAP port
|
|
526
|
-
* `ldap_provisioning_enabled` (boolean): Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
527
|
-
* `ldap_secure` (boolean): Use secure LDAP?
|
|
528
|
-
* `ldap_type` (string): LDAP server type
|
|
529
|
-
* `ldap_username` (string): Username for signing in to LDAP server.
|
|
530
|
-
* `ldap_username_field` (string): LDAP username field
|
|
531
|
-
* `protocol` (string): SSO Protocol
|
|
532
|
-
* `provider` (string): Provider name
|
|
533
|
-
* `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
|
|
534
|
-
* `provision_company` (string): Default company for auto provisioned users.
|
|
535
|
-
* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
|
|
536
|
-
* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
537
|
-
* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
|
|
538
|
-
* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
|
|
539
|
-
* `provision_group_admin_groups` (string): Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
540
|
-
* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
541
|
-
* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
542
|
-
* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
543
|
-
* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
544
|
-
* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
|
|
545
|
-
* `provision_readonly_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
546
|
-
* `provision_require_2fa` (string): 2FA required setting for auto provisioned users. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
|
|
547
|
-
* `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
|
|
548
|
-
* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
|
|
549
|
-
* `provision_time_zone` (string): Default time zone for auto provisioned users.
|
|
550
|
-
* `provision_users` (boolean): Auto-provision users?
|
|
551
|
-
* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
552
|
-
* `saml_provider_issuer_url` (string): Identity provider issuer url
|
|
553
|
-
* `saml_provider_metadata_content` (string): Custom identity provider metadata
|
|
554
|
-
* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
|
|
555
|
-
* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
|
|
556
|
-
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
557
|
-
* `scim_authentication_method` (string): SCIM authentication type.
|
|
558
|
-
* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
|
|
559
|
-
* `scim_username` (string): SCIM username.
|
|
560
|
-
* `subdomain` (string): Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
---
|
|
564
|
-
|
|
565
|
-
## Delete SSO Strategy
|
|
566
|
-
|
|
567
|
-
```
|
|
568
|
-
sso_strategy = Files::SsoStrategy.find(id)
|
|
569
|
-
|
|
570
|
-
sso_strategy.delete
|
|
571
|
-
```
|
|
572
|
-
|
|
573
|
-
### Parameters
|
|
574
|
-
|
|
575
|
-
* `id` (int64): Required - Sso Strategy ID.
|
data/docs/sync.md
CHANGED
|
@@ -230,20 +230,6 @@ Files::Sync.manual_run(id)
|
|
|
230
230
|
* `id` (int64): Required - Sync ID.
|
|
231
231
|
|
|
232
232
|
|
|
233
|
-
---
|
|
234
|
-
|
|
235
|
-
## Create an export CSV of Sync resources
|
|
236
|
-
|
|
237
|
-
```
|
|
238
|
-
Files::Sync.create_export
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
### Parameters
|
|
242
|
-
|
|
243
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id` or `name`.
|
|
244
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `disabled`, `src_remote_server_id` or `dest_remote_server_id`. Valid field combinations are `[ workspace_id, disabled ]`, `[ workspace_id, src_remote_server_id ]`, `[ workspace_id, dest_remote_server_id ]`, `[ disabled, src_remote_server_id ]`, `[ disabled, dest_remote_server_id ]`, `[ workspace_id, disabled, src_remote_server_id ]` or `[ workspace_id, disabled, dest_remote_server_id ]`.
|
|
245
|
-
|
|
246
|
-
|
|
247
233
|
---
|
|
248
234
|
|
|
249
235
|
## Update Sync
|
data/docs/sync_log.md
CHANGED
|
@@ -15,8 +15,7 @@
|
|
|
15
15
|
"size": 1,
|
|
16
16
|
"file_type": "example",
|
|
17
17
|
"status": "success",
|
|
18
|
-
"created_at": "2000-01-01T01:00:00Z"
|
|
19
|
-
"log_type": "example"
|
|
18
|
+
"created_at": "2000-01-01T01:00:00Z"
|
|
20
19
|
}
|
|
21
20
|
```
|
|
22
21
|
|
|
@@ -32,7 +31,6 @@
|
|
|
32
31
|
* `file_type` (string): File type
|
|
33
32
|
* `status` (string): Status
|
|
34
33
|
* `created_at` (date-time): Start Time of Action
|
|
35
|
-
* `log_type` (string): Log Type
|
|
36
34
|
|
|
37
35
|
|
|
38
36
|
---
|
|
@@ -52,20 +50,3 @@ Files::SyncLog.list
|
|
|
52
50
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
|
53
51
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
|
54
52
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
## Create an export CSV of Sync Log resources
|
|
60
|
-
|
|
61
|
-
```
|
|
62
|
-
Files::SyncLog.create_export
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Parameters
|
|
66
|
-
|
|
67
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `external_event_id`, `operation`, `status`, `sync_id`, `created_at` or `sync_run_id`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
|
68
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
|
69
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
|
70
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
|
71
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
|
data/docs/sync_run.md
CHANGED
|
@@ -101,24 +101,3 @@ Files::SyncRun.find(id)
|
|
|
101
101
|
### Parameters
|
|
102
102
|
|
|
103
103
|
* `id` (int64): Required - Sync Run ID.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## Create an export CSV of Sync Run resources
|
|
109
|
-
|
|
110
|
-
```
|
|
111
|
-
Files::SyncRun.create_export(
|
|
112
|
-
user_id: 1
|
|
113
|
-
)
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Parameters
|
|
117
|
-
|
|
118
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
119
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id`, `sync_id`, `created_at` or `status`.
|
|
120
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status`, `dry_run`, `workspace_id`, `src_remote_server_type`, `dest_remote_server_type` or `sync_id`. Valid field combinations are `[ status, created_at ]`, `[ workspace_id, created_at ]`, `[ src_remote_server_type, created_at ]`, `[ dest_remote_server_type, created_at ]`, `[ sync_id, created_at ]`, `[ workspace_id, status ]`, `[ src_remote_server_type, status ]`, `[ dest_remote_server_type, status ]`, `[ sync_id, status ]`, `[ workspace_id, src_remote_server_type ]`, `[ workspace_id, dest_remote_server_type ]`, `[ workspace_id, sync_id ]`, `[ workspace_id, status, created_at ]`, `[ src_remote_server_type, status, created_at ]`, `[ dest_remote_server_type, status, created_at ]`, `[ sync_id, status, created_at ]`, `[ workspace_id, src_remote_server_type, created_at ]`, `[ workspace_id, dest_remote_server_type, created_at ]`, `[ workspace_id, sync_id, created_at ]`, `[ workspace_id, src_remote_server_type, status ]`, `[ workspace_id, dest_remote_server_type, status ]`, `[ workspace_id, sync_id, status ]`, `[ workspace_id, src_remote_server_type, status, created_at ]`, `[ workspace_id, dest_remote_server_type, status, created_at ]` or `[ workspace_id, sync_id, status, created_at ]`.
|
|
121
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
122
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
123
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
124
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
@@ -57,21 +57,3 @@ Files::UsageDailySnapshot.list
|
|
|
57
57
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
|
|
58
58
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
|
|
59
59
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
## Create an export CSV of Usage Daily Snapshot resources
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
Files::UsageDailySnapshot.create_export
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### Parameters
|
|
71
|
-
|
|
72
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
|
|
73
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
|
74
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
|
|
75
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
|
|
76
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
|
|
77
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.
|
data/docs/usage_snapshot.md
CHANGED
|
@@ -57,12 +57,3 @@ Files::UsageSnapshot.list
|
|
|
57
57
|
|
|
58
58
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
59
59
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
## Create an export CSV of Usage Snapshot resources
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
Files::UsageSnapshot.create_export
|
|
68
|
-
```
|