files.com 1.1.669 → 1.1.671
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/README.md +1 -0
- data/_VERSION +1 -1
- data/docs/account.md +155 -0
- data/docs/action_log.md +21 -1
- data/docs/action_notification_export_result.md +17 -0
- data/docs/action_webhook_failure.md +28 -0
- data/docs/agent_proxy_identity.md +49 -0
- data/docs/agent_proxy_identity_endpoint.md +11 -0
- data/docs/agent_proxy_identity_result.md +24 -0
- data/docs/agent_v2_auth.md +17 -0
- data/docs/ai_assistant_personality.md +14 -0
- data/docs/ai_task.md +14 -0
- data/docs/announcement.md +57 -0
- data/docs/api_key.md +27 -1
- data/docs/api_request_log.md +21 -1
- data/docs/app.md +15 -0
- data/docs/as2_incoming_message.md +18 -0
- data/docs/as2_outgoing_message.md +18 -0
- data/docs/as2_partner.md +14 -0
- data/docs/as2_station.md +14 -0
- data/docs/automation.md +22 -1
- data/docs/automation_log.md +21 -1
- data/docs/automation_run.md +19 -0
- data/docs/bandwidth_snapshot.md +18 -0
- data/docs/behavior.md +14 -0
- data/docs/blog_post.md +57 -0
- data/docs/bundle.md +50 -1
- data/docs/bundle_action.md +25 -0
- data/docs/bundle_download.md +23 -0
- data/docs/bundle_notification.md +19 -0
- data/docs/bundle_recipient.md +21 -0
- data/docs/bundle_recipient_registration.md +39 -0
- data/docs/bundle_registration.md +61 -0
- data/docs/certificate.md +258 -0
- data/docs/chat_session.md +14 -0
- data/docs/child_site.md +583 -0
- data/docs/child_site_management_policy.md +9 -0
- data/docs/clickwrap.md +13 -0
- data/docs/clickwrap_acceptance.md +30 -0
- data/docs/client_log.md +17 -0
- data/docs/crash_report.md +50 -0
- data/docs/custom_domain.md +13 -0
- data/docs/custom_domain_for_proxy.md +23 -0
- data/docs/desktop_configuration_profile.md +14 -0
- data/docs/dns_record.md +9 -0
- data/docs/email_incoming_message.md +19 -0
- data/docs/email_log.md +20 -1
- data/docs/email_preference.md +108 -0
- data/docs/email_preference_bundle_notification.md +15 -0
- data/docs/email_preference_notification.md +17 -0
- data/docs/event_channel.md +14 -0
- data/docs/event_delivery_attempt.md +14 -0
- data/docs/event_record.md +19 -0
- data/docs/event_subscription.md +14 -0
- data/docs/event_target.md +14 -0
- data/docs/exavault_api_request_log.md +21 -1
- data/docs/expectation.md +14 -0
- data/docs/expectation_evaluation.md +14 -0
- data/docs/expectation_incident.md +14 -0
- data/docs/export.md +90 -0
- data/docs/external_event.md +18 -0
- data/docs/file.md +90 -2
- data/docs/file_migration.md +32 -0
- data/docs/file_migration_log.md +20 -1
- data/docs/file_upload_part.md +3 -1
- data/docs/folder.md +20 -0
- data/docs/form_field_set.md +15 -0
- data/docs/front_end_server.md +111 -0
- data/docs/frontend_metric.md +34 -0
- data/docs/ftp_action_log.md +21 -1
- data/docs/gpg_key.md +21 -0
- data/docs/group.md +19 -0
- data/docs/group_user.md +22 -2
- data/docs/history.md +85 -0
- data/docs/history_export_result.md +17 -0
- data/docs/holiday_region.md +9 -0
- data/docs/inbound_s3_log.md +21 -1
- data/docs/inbox.md +102 -0
- data/docs/inbox_recipient.md +19 -0
- data/docs/inbox_recipient_registration.md +35 -0
- data/docs/inbox_registration.md +57 -0
- data/docs/inbox_upload.md +18 -0
- data/docs/invoice.md +9 -0
- data/docs/ip.md +63 -0
- data/docs/ip_abuse_entry.md +47 -0
- data/docs/ip_address.md +59 -0
- data/docs/key_lifecycle_rule.md +14 -0
- data/docs/label.md +9 -0
- data/docs/lead.md +161 -0
- data/docs/lock.md +15 -0
- data/docs/message.md +17 -0
- data/docs/message_comment.md +18 -0
- data/docs/message_comment_reaction.md +18 -0
- data/docs/message_reaction.md +17 -0
- data/docs/metadata_category.md +13 -0
- data/docs/monitoring_stat.md +38 -0
- data/docs/monitoring_stats.md +15 -0
- data/docs/mover_package.md +68 -0
- data/docs/notification.md +20 -0
- data/docs/nps_response.md +75 -0
- data/docs/oauth_redirect.md +11 -0
- data/docs/outbound_connection_log.md +21 -1
- data/docs/paired_api_key.md +19 -0
- data/docs/partner.md +14 -0
- data/docs/partner_channel.md +14 -0
- data/docs/partner_site_request.md +14 -0
- data/docs/payment.md +9 -0
- data/docs/paypal_express_info.md +31 -0
- data/docs/paypal_express_url.md +11 -0
- data/docs/pending_work_event.md +18 -0
- data/docs/permission.md +22 -0
- data/docs/plan.md +107 -0
- data/docs/preview.md +57 -0
- data/docs/project.md +9 -0
- data/docs/public_hosting_request_log.md +21 -1
- data/docs/public_hosting_session_pairing.md +15 -0
- data/docs/public_inbox.md +121 -0
- data/docs/public_key.md +21 -0
- data/docs/public_url.md +59 -0
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +83 -0
- data/docs/release_package.md +19 -0
- data/docs/remote_bandwidth_snapshot.md +18 -0
- data/docs/remote_mount_backend.md +13 -0
- data/docs/remote_server.md +233 -0
- data/docs/remote_server_credential.md +15 -0
- data/docs/request.md +17 -0
- data/docs/restore.md +14 -0
- data/docs/revision.md +40 -0
- data/docs/safe_plan.md +0 -0
- data/docs/scheduled_export.md +15 -0
- data/docs/scim_log.md +13 -0
- data/docs/session.md +232 -1
- data/docs/session_available_site.md +26 -0
- data/docs/setting.md +33 -0
- data/docs/settings.md +498 -0
- data/docs/settings_change.md +16 -0
- data/docs/sftp_action_log.md +21 -1
- data/docs/sftp_host_key.md +9 -0
- data/docs/share_group.md +15 -0
- data/docs/siem_http_destination.md +9 -0
- data/docs/siem_http_destination_event.md +18 -0
- data/docs/site.md +179 -0
- data/docs/site_subdomain_redirect.md +13 -0
- data/docs/snapshot.md +9 -0
- data/docs/ssl_certificate.md +37 -0
- data/docs/sso_event.md +19 -0
- data/docs/sso_strategy.md +406 -0
- data/docs/staging_site.md +591 -0
- data/docs/support_request.md +126 -0
- data/docs/sync.md +14 -0
- data/docs/sync_api_usage_snapshot.md +23 -0
- data/docs/sync_api_usage_snapshot_report.md +71 -0
- data/docs/sync_bandwidth_snapshot.md +48 -0
- data/docs/sync_log.md +20 -1
- data/docs/sync_run.md +21 -0
- data/docs/two_factor_authentication_method.md +169 -0
- data/docs/usage_daily_snapshot.md +18 -0
- data/docs/usage_snapshot.md +9 -0
- data/docs/user.md +49 -2
- data/docs/user_cipher_use.md +21 -0
- data/docs/user_lifecycle_rule.md +14 -0
- data/docs/user_request.md +9 -0
- data/docs/user_security_event.md +18 -0
- data/docs/user_sftp_client_use.md +15 -0
- data/docs/warning.md +36 -0
- data/docs/web_dav_action_log.md +21 -1
- data/docs/webauthn_sign_request.md +13 -0
- data/docs/workspace.md +15 -0
- data/docs/zip_download.md +32 -0
- data/docs/zip_download_file.md +45 -0
- data/docs/zip_download_files.md +23 -0
- data/lib/files.com/errors.rb +1 -0
- data/lib/files.com/models/account.rb +346 -0
- data/lib/files.com/models/action_log.rb +24 -0
- data/lib/files.com/models/action_notification_export_result.rb +12 -0
- data/lib/files.com/models/action_webhook_failure.rb +34 -0
- data/lib/files.com/models/agent_proxy_identity.rb +47 -0
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
- data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
- data/lib/files.com/models/agent_v2_auth.rb +32 -0
- data/lib/files.com/models/ai_assistant_personality.rb +11 -0
- data/lib/files.com/models/ai_task.rb +11 -0
- data/lib/files.com/models/announcement.rb +89 -0
- data/lib/files.com/models/api_key.rb +39 -5
- data/lib/files.com/models/api_request_log.rb +24 -0
- data/lib/files.com/models/app.rb +13 -0
- data/lib/files.com/models/as2_incoming_message.rb +19 -0
- data/lib/files.com/models/as2_outgoing_message.rb +19 -0
- data/lib/files.com/models/as2_partner.rb +11 -0
- data/lib/files.com/models/as2_station.rb +11 -0
- data/lib/files.com/models/automation.rb +30 -0
- data/lib/files.com/models/automation_log.rb +24 -0
- data/lib/files.com/models/automation_run.rb +16 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/behavior.rb +11 -0
- data/lib/files.com/models/blog_post.rb +84 -0
- data/lib/files.com/models/bundle.rb +52 -0
- data/lib/files.com/models/bundle_action.rb +25 -0
- data/lib/files.com/models/bundle_download.rb +23 -0
- data/lib/files.com/models/bundle_notification.rb +15 -0
- data/lib/files.com/models/bundle_recipient.rb +27 -0
- data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
- data/lib/files.com/models/bundle_registration.rb +125 -0
- data/lib/files.com/models/certificate.rb +455 -0
- data/lib/files.com/models/chat_session.rb +11 -0
- data/lib/files.com/models/child_site.rb +1756 -0
- data/lib/files.com/models/child_site_management_policy.rb +5 -0
- data/lib/files.com/models/clickwrap.rb +9 -0
- data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
- data/lib/files.com/models/client_log.rb +25 -0
- data/lib/files.com/models/crash_report.rb +151 -0
- data/lib/files.com/models/custom_domain.rb +9 -0
- data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
- data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
- data/lib/files.com/models/dns_record.rb +5 -0
- data/lib/files.com/models/email_incoming_message.rb +21 -0
- data/lib/files.com/models/email_log.rb +22 -0
- data/lib/files.com/models/email_preference.rb +124 -0
- data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
- data/lib/files.com/models/email_preference_notification.rb +32 -0
- data/lib/files.com/models/event_channel.rb +11 -0
- data/lib/files.com/models/event_delivery_attempt.rb +11 -0
- data/lib/files.com/models/event_record.rb +21 -0
- data/lib/files.com/models/event_subscription.rb +11 -0
- data/lib/files.com/models/event_target.rb +11 -0
- data/lib/files.com/models/exavault_api_request_log.rb +24 -0
- data/lib/files.com/models/expectation.rb +11 -0
- data/lib/files.com/models/expectation_evaluation.rb +11 -0
- data/lib/files.com/models/expectation_incident.rb +11 -0
- data/lib/files.com/models/export.rb +153 -0
- data/lib/files.com/models/external_event.rb +19 -0
- data/lib/files.com/models/file.rb +207 -0
- data/lib/files.com/models/file_migration.rb +27 -0
- data/lib/files.com/models/file_migration_log.rb +22 -0
- data/lib/files.com/models/file_upload_part.rb +5 -0
- data/lib/files.com/models/folder.rb +69 -0
- data/lib/files.com/models/form_field_set.rb +9 -0
- data/lib/files.com/models/front_end_server.rb +335 -0
- data/lib/files.com/models/frontend_metric.rb +65 -0
- data/lib/files.com/models/ftp_action_log.rb +24 -0
- data/lib/files.com/models/gpg_key.rb +21 -0
- data/lib/files.com/models/group.rb +16 -0
- data/lib/files.com/models/group_user.rb +21 -1
- data/lib/files.com/models/history.rb +94 -0
- data/lib/files.com/models/history_export_result.rb +12 -0
- data/lib/files.com/models/holiday_region.rb +5 -0
- data/lib/files.com/models/inbound_s3_log.rb +24 -0
- data/lib/files.com/models/inbox.rb +123 -0
- data/lib/files.com/models/inbox_recipient.rb +25 -0
- data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
- data/lib/files.com/models/inbox_registration.rb +121 -0
- data/lib/files.com/models/inbox_upload.rb +19 -0
- data/lib/files.com/models/invoice.rb +5 -0
- data/lib/files.com/models/ip.rb +82 -0
- data/lib/files.com/models/ip_abuse_entry.rb +96 -0
- data/lib/files.com/models/ip_address.rb +37 -0
- data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/label.rb +22 -0
- data/lib/files.com/models/lead.rb +434 -0
- data/lib/files.com/models/lock.rb +27 -0
- data/lib/files.com/models/message.rb +12 -0
- data/lib/files.com/models/message_comment.rb +14 -0
- data/lib/files.com/models/message_comment_reaction.rb +14 -0
- data/lib/files.com/models/message_reaction.rb +12 -0
- data/lib/files.com/models/metadata_category.rb +9 -0
- data/lib/files.com/models/monitoring_stat.rb +43 -0
- data/lib/files.com/models/monitoring_stats.rb +22 -0
- data/lib/files.com/models/mover_package.rb +80 -0
- data/lib/files.com/models/notification.rb +18 -0
- data/lib/files.com/models/nps_response.rb +128 -0
- data/lib/files.com/models/oauth_redirect.rb +17 -0
- data/lib/files.com/models/outbound_connection_log.rb +24 -0
- data/lib/files.com/models/paired_api_key.rb +37 -0
- data/lib/files.com/models/partner.rb +11 -0
- data/lib/files.com/models/partner_channel.rb +11 -0
- data/lib/files.com/models/partner_site_request.rb +11 -0
- data/lib/files.com/models/payment.rb +5 -0
- data/lib/files.com/models/paypal_express_info.rb +67 -0
- data/lib/files.com/models/paypal_express_url.rb +17 -0
- data/lib/files.com/models/pending_work_event.rb +19 -0
- data/lib/files.com/models/permission.rb +22 -0
- data/lib/files.com/models/plan.rb +209 -0
- data/lib/files.com/models/preview.rb +57 -0
- data/lib/files.com/models/project.rb +5 -0
- data/lib/files.com/models/public_hosting_request_log.rb +24 -0
- data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
- data/lib/files.com/models/public_inbox.rb +142 -0
- data/lib/files.com/models/public_key.rb +21 -0
- data/lib/files.com/models/public_url.rb +177 -0
- data/lib/files.com/models/regional_migration.rb +12 -0
- data/lib/files.com/models/release.rb +153 -0
- data/lib/files.com/models/release_package.rb +37 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/remote_mount_backend.rb +9 -0
- data/lib/files.com/models/remote_server.rb +297 -0
- data/lib/files.com/models/remote_server_credential.rb +13 -0
- data/lib/files.com/models/request.rb +12 -0
- data/lib/files.com/models/restore.rb +11 -0
- data/lib/files.com/models/revision.rb +53 -0
- data/lib/files.com/models/safe_plan.rb +12 -0
- data/lib/files.com/models/scheduled_export.rb +13 -0
- data/lib/files.com/models/scim_log.rb +9 -0
- data/lib/files.com/models/session.rb +493 -0
- data/lib/files.com/models/session_available_site.rb +47 -0
- data/lib/files.com/models/setting.rb +36 -0
- data/lib/files.com/models/settings.rb +1072 -0
- data/lib/files.com/models/settings_change.rb +16 -0
- data/lib/files.com/models/sftp_action_log.rb +24 -0
- data/lib/files.com/models/sftp_host_key.rb +5 -0
- data/lib/files.com/models/share_group.rb +9 -0
- data/lib/files.com/models/siem_http_destination.rb +5 -0
- data/lib/files.com/models/siem_http_destination_event.rb +19 -0
- data/lib/files.com/models/site.rb +1021 -0
- data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
- data/lib/files.com/models/snapshot.rb +5 -0
- data/lib/files.com/models/ssl_certificate.rb +77 -0
- data/lib/files.com/models/sso_event.rb +21 -0
- data/lib/files.com/models/sso_strategy.rb +632 -0
- data/lib/files.com/models/staging_site.rb +1781 -0
- data/lib/files.com/models/support_request.rb +209 -0
- data/lib/files.com/models/sync.rb +11 -0
- data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
- data/lib/files.com/models/sync_log.rb +22 -0
- data/lib/files.com/models/sync_run.rb +21 -0
- data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
- data/lib/files.com/models/usage_snapshot.rb +5 -0
- data/lib/files.com/models/user.rb +59 -0
- data/lib/files.com/models/user_cipher_use.rb +21 -0
- data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/user_request.rb +5 -0
- data/lib/files.com/models/user_security_event.rb +19 -0
- data/lib/files.com/models/user_sftp_client_use.rb +9 -0
- data/lib/files.com/models/warning.rb +38 -0
- data/lib/files.com/models/web_dav_action_log.rb +24 -0
- data/lib/files.com/models/webauthn_sign_request.rb +17 -0
- data/lib/files.com/models/workspace.rb +13 -0
- data/lib/files.com/models/zip_download.rb +73 -0
- data/lib/files.com/models/zip_download_file.rb +111 -0
- data/lib/files.com/models/zip_download_files.rb +42 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +59 -0
- metadata +120 -2
|
@@ -14,261 +14,532 @@ module Files
|
|
|
14
14
|
@attributes[:protocol]
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
+
def protocol=(value)
|
|
18
|
+
@attributes[:protocol] = value
|
|
19
|
+
end
|
|
20
|
+
|
|
17
21
|
# string - Provider name
|
|
18
22
|
def provider
|
|
19
23
|
@attributes[:provider]
|
|
20
24
|
end
|
|
21
25
|
|
|
26
|
+
def provider=(value)
|
|
27
|
+
@attributes[:provider] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
22
30
|
# string - Custom label for the SSO provider on the login page.
|
|
23
31
|
def label
|
|
24
32
|
@attributes[:label]
|
|
25
33
|
end
|
|
26
34
|
|
|
35
|
+
def label=(value)
|
|
36
|
+
@attributes[:label] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
27
39
|
# string - URL holding a custom logo for the SSO provider on the login page.
|
|
28
40
|
def logo_url
|
|
29
41
|
@attributes[:logo_url]
|
|
30
42
|
end
|
|
31
43
|
|
|
44
|
+
def logo_url=(value)
|
|
45
|
+
@attributes[:logo_url] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
32
48
|
# int64 - ID
|
|
33
49
|
def id
|
|
34
50
|
@attributes[:id]
|
|
35
51
|
end
|
|
36
52
|
|
|
53
|
+
def id=(value)
|
|
54
|
+
@attributes[:id] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
37
57
|
# int64 - Count of users with this SSO Strategy
|
|
38
58
|
def user_count
|
|
39
59
|
@attributes[:user_count]
|
|
40
60
|
end
|
|
41
61
|
|
|
62
|
+
def user_count=(value)
|
|
63
|
+
@attributes[:user_count] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
42
66
|
# string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
43
67
|
def saml_provider_cert_fingerprint
|
|
44
68
|
@attributes[:saml_provider_cert_fingerprint]
|
|
45
69
|
end
|
|
46
70
|
|
|
71
|
+
def saml_provider_cert_fingerprint=(value)
|
|
72
|
+
@attributes[:saml_provider_cert_fingerprint] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
47
75
|
# string - Identity provider issuer url
|
|
48
76
|
def saml_provider_issuer_url
|
|
49
77
|
@attributes[:saml_provider_issuer_url]
|
|
50
78
|
end
|
|
51
79
|
|
|
80
|
+
def saml_provider_issuer_url=(value)
|
|
81
|
+
@attributes[:saml_provider_issuer_url] = value
|
|
82
|
+
end
|
|
83
|
+
|
|
52
84
|
# string - Custom identity provider metadata
|
|
53
85
|
def saml_provider_metadata_content
|
|
54
86
|
@attributes[:saml_provider_metadata_content]
|
|
55
87
|
end
|
|
56
88
|
|
|
89
|
+
def saml_provider_metadata_content=(value)
|
|
90
|
+
@attributes[:saml_provider_metadata_content] = value
|
|
91
|
+
end
|
|
92
|
+
|
|
57
93
|
# string - Metadata URL for the SAML identity provider
|
|
58
94
|
def saml_provider_metadata_url
|
|
59
95
|
@attributes[:saml_provider_metadata_url]
|
|
60
96
|
end
|
|
61
97
|
|
|
98
|
+
def saml_provider_metadata_url=(value)
|
|
99
|
+
@attributes[:saml_provider_metadata_url] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
62
102
|
# string - Identity provider SLO endpoint
|
|
63
103
|
def saml_provider_slo_target_url
|
|
64
104
|
@attributes[:saml_provider_slo_target_url]
|
|
65
105
|
end
|
|
66
106
|
|
|
107
|
+
def saml_provider_slo_target_url=(value)
|
|
108
|
+
@attributes[:saml_provider_slo_target_url] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
67
111
|
# string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
68
112
|
def saml_provider_sso_target_url
|
|
69
113
|
@attributes[:saml_provider_sso_target_url]
|
|
70
114
|
end
|
|
71
115
|
|
|
116
|
+
def saml_provider_sso_target_url=(value)
|
|
117
|
+
@attributes[:saml_provider_sso_target_url] = value
|
|
118
|
+
end
|
|
119
|
+
|
|
72
120
|
# string - SCIM authentication type.
|
|
73
121
|
def scim_authentication_method
|
|
74
122
|
@attributes[:scim_authentication_method]
|
|
75
123
|
end
|
|
76
124
|
|
|
125
|
+
def scim_authentication_method=(value)
|
|
126
|
+
@attributes[:scim_authentication_method] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
77
129
|
# string - SCIM username.
|
|
78
130
|
def scim_username
|
|
79
131
|
@attributes[:scim_username]
|
|
80
132
|
end
|
|
81
133
|
|
|
134
|
+
def scim_username=(value)
|
|
135
|
+
@attributes[:scim_username] = value
|
|
136
|
+
end
|
|
137
|
+
|
|
82
138
|
# string - SCIM OAuth Access Token.
|
|
83
139
|
def scim_oauth_access_token
|
|
84
140
|
@attributes[:scim_oauth_access_token]
|
|
85
141
|
end
|
|
86
142
|
|
|
143
|
+
def scim_oauth_access_token=(value)
|
|
144
|
+
@attributes[:scim_oauth_access_token] = value
|
|
145
|
+
end
|
|
146
|
+
|
|
87
147
|
# string - SCIM OAuth Access Token Expiration Time.
|
|
88
148
|
def scim_oauth_access_token_expires_at
|
|
89
149
|
@attributes[:scim_oauth_access_token_expires_at]
|
|
90
150
|
end
|
|
91
151
|
|
|
152
|
+
def scim_oauth_access_token_expires_at=(value)
|
|
153
|
+
@attributes[:scim_oauth_access_token_expires_at] = value
|
|
154
|
+
end
|
|
155
|
+
|
|
92
156
|
# string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
93
157
|
def subdomain
|
|
94
158
|
@attributes[:subdomain]
|
|
95
159
|
end
|
|
96
160
|
|
|
161
|
+
def subdomain=(value)
|
|
162
|
+
@attributes[:subdomain] = value
|
|
163
|
+
end
|
|
164
|
+
|
|
97
165
|
# boolean - Auto-provision users?
|
|
98
166
|
def provision_users
|
|
99
167
|
@attributes[:provision_users]
|
|
100
168
|
end
|
|
101
169
|
|
|
170
|
+
def provision_users=(value)
|
|
171
|
+
@attributes[:provision_users] = value
|
|
172
|
+
end
|
|
173
|
+
|
|
102
174
|
# boolean - Auto-provision group membership based on group memberships on the SSO side?
|
|
103
175
|
def provision_groups
|
|
104
176
|
@attributes[:provision_groups]
|
|
105
177
|
end
|
|
106
178
|
|
|
179
|
+
def provision_groups=(value)
|
|
180
|
+
@attributes[:provision_groups] = value
|
|
181
|
+
end
|
|
182
|
+
|
|
107
183
|
# boolean - Auto-deprovision users?
|
|
108
184
|
def deprovision_users
|
|
109
185
|
@attributes[:deprovision_users]
|
|
110
186
|
end
|
|
111
187
|
|
|
188
|
+
def deprovision_users=(value)
|
|
189
|
+
@attributes[:deprovision_users] = value
|
|
190
|
+
end
|
|
191
|
+
|
|
112
192
|
# boolean - Auto-deprovision group membership based on group memberships on the SSO side?
|
|
113
193
|
def deprovision_groups
|
|
114
194
|
@attributes[:deprovision_groups]
|
|
115
195
|
end
|
|
116
196
|
|
|
197
|
+
def deprovision_groups=(value)
|
|
198
|
+
@attributes[:deprovision_groups] = value
|
|
199
|
+
end
|
|
200
|
+
|
|
117
201
|
# string - Method used for deprovisioning users.
|
|
118
202
|
def deprovision_behavior
|
|
119
203
|
@attributes[:deprovision_behavior]
|
|
120
204
|
end
|
|
121
205
|
|
|
206
|
+
def deprovision_behavior=(value)
|
|
207
|
+
@attributes[:deprovision_behavior] = value
|
|
208
|
+
end
|
|
209
|
+
|
|
122
210
|
# string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
123
211
|
def provision_group_default
|
|
124
212
|
@attributes[:provision_group_default]
|
|
125
213
|
end
|
|
126
214
|
|
|
215
|
+
def provision_group_default=(value)
|
|
216
|
+
@attributes[:provision_group_default] = value
|
|
217
|
+
end
|
|
218
|
+
|
|
127
219
|
# string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
128
220
|
def provision_group_exclusion
|
|
129
221
|
@attributes[:provision_group_exclusion]
|
|
130
222
|
end
|
|
131
223
|
|
|
224
|
+
def provision_group_exclusion=(value)
|
|
225
|
+
@attributes[:provision_group_exclusion] = value
|
|
226
|
+
end
|
|
227
|
+
|
|
132
228
|
# string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
133
229
|
def provision_group_inclusion
|
|
134
230
|
@attributes[:provision_group_inclusion]
|
|
135
231
|
end
|
|
136
232
|
|
|
233
|
+
def provision_group_inclusion=(value)
|
|
234
|
+
@attributes[:provision_group_inclusion] = value
|
|
235
|
+
end
|
|
236
|
+
|
|
137
237
|
# string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
138
238
|
def provision_group_required
|
|
139
239
|
@attributes[:provision_group_required]
|
|
140
240
|
end
|
|
141
241
|
|
|
242
|
+
def provision_group_required=(value)
|
|
243
|
+
@attributes[:provision_group_required] = value
|
|
244
|
+
end
|
|
245
|
+
|
|
142
246
|
# string - Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
143
247
|
def provision_email_signup_groups
|
|
144
248
|
@attributes[:provision_email_signup_groups]
|
|
145
249
|
end
|
|
146
250
|
|
|
251
|
+
def provision_email_signup_groups=(value)
|
|
252
|
+
@attributes[:provision_email_signup_groups] = value
|
|
253
|
+
end
|
|
254
|
+
|
|
147
255
|
# string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
148
256
|
def provision_readonly_site_admin_groups
|
|
149
257
|
@attributes[:provision_readonly_site_admin_groups]
|
|
150
258
|
end
|
|
151
259
|
|
|
260
|
+
def provision_readonly_site_admin_groups=(value)
|
|
261
|
+
@attributes[:provision_readonly_site_admin_groups] = value
|
|
262
|
+
end
|
|
263
|
+
|
|
152
264
|
# string - Comma-separated list of group names whose members will be created as Site Admins.
|
|
153
265
|
def provision_site_admin_groups
|
|
154
266
|
@attributes[:provision_site_admin_groups]
|
|
155
267
|
end
|
|
156
268
|
|
|
269
|
+
def provision_site_admin_groups=(value)
|
|
270
|
+
@attributes[:provision_site_admin_groups] = value
|
|
271
|
+
end
|
|
272
|
+
|
|
157
273
|
# string - Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
158
274
|
def provision_group_admin_groups
|
|
159
275
|
@attributes[:provision_group_admin_groups]
|
|
160
276
|
end
|
|
161
277
|
|
|
278
|
+
def provision_group_admin_groups=(value)
|
|
279
|
+
@attributes[:provision_group_admin_groups] = value
|
|
280
|
+
end
|
|
281
|
+
|
|
162
282
|
# boolean
|
|
163
283
|
def provision_attachments_permission
|
|
164
284
|
@attributes[:provision_attachments_permission]
|
|
165
285
|
end
|
|
166
286
|
|
|
287
|
+
def provision_attachments_permission=(value)
|
|
288
|
+
@attributes[:provision_attachments_permission] = value
|
|
289
|
+
end
|
|
290
|
+
|
|
167
291
|
# boolean - Auto-provisioned users get WebDAV permission?
|
|
168
292
|
def provision_dav_permission
|
|
169
293
|
@attributes[:provision_dav_permission]
|
|
170
294
|
end
|
|
171
295
|
|
|
296
|
+
def provision_dav_permission=(value)
|
|
297
|
+
@attributes[:provision_dav_permission] = value
|
|
298
|
+
end
|
|
299
|
+
|
|
172
300
|
# boolean - Auto-provisioned users get FTP permission?
|
|
173
301
|
def provision_ftp_permission
|
|
174
302
|
@attributes[:provision_ftp_permission]
|
|
175
303
|
end
|
|
176
304
|
|
|
305
|
+
def provision_ftp_permission=(value)
|
|
306
|
+
@attributes[:provision_ftp_permission] = value
|
|
307
|
+
end
|
|
308
|
+
|
|
177
309
|
# boolean - Auto-provisioned users get SFTP permission?
|
|
178
310
|
def provision_sftp_permission
|
|
179
311
|
@attributes[:provision_sftp_permission]
|
|
180
312
|
end
|
|
181
313
|
|
|
314
|
+
def provision_sftp_permission=(value)
|
|
315
|
+
@attributes[:provision_sftp_permission] = value
|
|
316
|
+
end
|
|
317
|
+
|
|
182
318
|
# string - Default time zone for auto provisioned users.
|
|
183
319
|
def provision_time_zone
|
|
184
320
|
@attributes[:provision_time_zone]
|
|
185
321
|
end
|
|
186
322
|
|
|
323
|
+
def provision_time_zone=(value)
|
|
324
|
+
@attributes[:provision_time_zone] = value
|
|
325
|
+
end
|
|
326
|
+
|
|
187
327
|
# string - Default company for auto provisioned users.
|
|
188
328
|
def provision_company
|
|
189
329
|
@attributes[:provision_company]
|
|
190
330
|
end
|
|
191
331
|
|
|
332
|
+
def provision_company=(value)
|
|
333
|
+
@attributes[:provision_company] = value
|
|
334
|
+
end
|
|
335
|
+
|
|
192
336
|
# 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.
|
|
193
337
|
def provision_require_2fa
|
|
194
338
|
@attributes[:provision_require_2fa]
|
|
195
339
|
end
|
|
196
340
|
|
|
341
|
+
def provision_require_2fa=(value)
|
|
342
|
+
@attributes[:provision_require_2fa] = value
|
|
343
|
+
end
|
|
344
|
+
|
|
197
345
|
# string - File System layout to use for auto provisioned users.
|
|
198
346
|
def provision_filesystem_layout
|
|
199
347
|
@attributes[:provision_filesystem_layout]
|
|
200
348
|
end
|
|
201
349
|
|
|
350
|
+
def provision_filesystem_layout=(value)
|
|
351
|
+
@attributes[:provision_filesystem_layout] = value
|
|
352
|
+
end
|
|
353
|
+
|
|
202
354
|
# string - URL-friendly, unique identifier for Azure SAML configuration
|
|
203
355
|
def provider_identifier
|
|
204
356
|
@attributes[:provider_identifier]
|
|
205
357
|
end
|
|
206
358
|
|
|
359
|
+
def provider_identifier=(value)
|
|
360
|
+
@attributes[:provider_identifier] = value
|
|
361
|
+
end
|
|
362
|
+
|
|
207
363
|
# string - Base DN for looking up users in LDAP server
|
|
208
364
|
def ldap_base_dn
|
|
209
365
|
@attributes[:ldap_base_dn]
|
|
210
366
|
end
|
|
211
367
|
|
|
368
|
+
def ldap_base_dn=(value)
|
|
369
|
+
@attributes[:ldap_base_dn] = value
|
|
370
|
+
end
|
|
371
|
+
|
|
212
372
|
# string - Domain name that will be appended to LDAP usernames
|
|
213
373
|
def ldap_domain
|
|
214
374
|
@attributes[:ldap_domain]
|
|
215
375
|
end
|
|
216
376
|
|
|
377
|
+
def ldap_domain=(value)
|
|
378
|
+
@attributes[:ldap_domain] = value
|
|
379
|
+
end
|
|
380
|
+
|
|
217
381
|
# boolean - Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
218
382
|
def enabled
|
|
219
383
|
@attributes[:enabled]
|
|
220
384
|
end
|
|
221
385
|
|
|
386
|
+
def enabled=(value)
|
|
387
|
+
@attributes[:enabled] = value
|
|
388
|
+
end
|
|
389
|
+
|
|
222
390
|
# boolean - Should this strategy be displayed on the login page?
|
|
223
391
|
def display_on_login_page
|
|
224
392
|
@attributes[:display_on_login_page]
|
|
225
393
|
end
|
|
226
394
|
|
|
395
|
+
def display_on_login_page=(value)
|
|
396
|
+
@attributes[:display_on_login_page] = value
|
|
397
|
+
end
|
|
398
|
+
|
|
227
399
|
# string - LDAP host
|
|
228
400
|
def ldap_host
|
|
229
401
|
@attributes[:ldap_host]
|
|
230
402
|
end
|
|
231
403
|
|
|
404
|
+
def ldap_host=(value)
|
|
405
|
+
@attributes[:ldap_host] = value
|
|
406
|
+
end
|
|
407
|
+
|
|
232
408
|
# string - LDAP backup host
|
|
233
409
|
def ldap_host_2
|
|
234
410
|
@attributes[:ldap_host_2]
|
|
235
411
|
end
|
|
236
412
|
|
|
413
|
+
def ldap_host_2=(value)
|
|
414
|
+
@attributes[:ldap_host_2] = value
|
|
415
|
+
end
|
|
416
|
+
|
|
237
417
|
# string - LDAP backup host
|
|
238
418
|
def ldap_host_3
|
|
239
419
|
@attributes[:ldap_host_3]
|
|
240
420
|
end
|
|
241
421
|
|
|
422
|
+
def ldap_host_3=(value)
|
|
423
|
+
@attributes[:ldap_host_3] = value
|
|
424
|
+
end
|
|
425
|
+
|
|
242
426
|
# int64 - LDAP port
|
|
243
427
|
def ldap_port
|
|
244
428
|
@attributes[:ldap_port]
|
|
245
429
|
end
|
|
246
430
|
|
|
431
|
+
def ldap_port=(value)
|
|
432
|
+
@attributes[:ldap_port] = value
|
|
433
|
+
end
|
|
434
|
+
|
|
247
435
|
# boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
248
436
|
def ldap_provisioning_enabled
|
|
249
437
|
@attributes[:ldap_provisioning_enabled]
|
|
250
438
|
end
|
|
251
439
|
|
|
440
|
+
def ldap_provisioning_enabled=(value)
|
|
441
|
+
@attributes[:ldap_provisioning_enabled] = value
|
|
442
|
+
end
|
|
443
|
+
|
|
252
444
|
# boolean - Use secure LDAP?
|
|
253
445
|
def ldap_secure
|
|
254
446
|
@attributes[:ldap_secure]
|
|
255
447
|
end
|
|
256
448
|
|
|
449
|
+
def ldap_secure=(value)
|
|
450
|
+
@attributes[:ldap_secure] = value
|
|
451
|
+
end
|
|
452
|
+
|
|
257
453
|
# string - LDAP server type
|
|
258
454
|
def ldap_type
|
|
259
455
|
@attributes[:ldap_type]
|
|
260
456
|
end
|
|
261
457
|
|
|
458
|
+
def ldap_type=(value)
|
|
459
|
+
@attributes[:ldap_type] = value
|
|
460
|
+
end
|
|
461
|
+
|
|
262
462
|
# string - Username for signing in to LDAP server.
|
|
263
463
|
def ldap_username
|
|
264
464
|
@attributes[:ldap_username]
|
|
265
465
|
end
|
|
266
466
|
|
|
467
|
+
def ldap_username=(value)
|
|
468
|
+
@attributes[:ldap_username] = value
|
|
469
|
+
end
|
|
470
|
+
|
|
267
471
|
# string - LDAP username field
|
|
268
472
|
def ldap_username_field
|
|
269
473
|
@attributes[:ldap_username_field]
|
|
270
474
|
end
|
|
271
475
|
|
|
476
|
+
def ldap_username_field=(value)
|
|
477
|
+
@attributes[:ldap_username_field] = value
|
|
478
|
+
end
|
|
479
|
+
|
|
480
|
+
# string - OAuth Client ID for your auth provider.
|
|
481
|
+
def client_id
|
|
482
|
+
@attributes[:client_id]
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
def client_id=(value)
|
|
486
|
+
@attributes[:client_id] = value
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
# string - OAuth Client Secret for your auth provider.
|
|
490
|
+
def client_secret
|
|
491
|
+
@attributes[:client_secret]
|
|
492
|
+
end
|
|
493
|
+
|
|
494
|
+
def client_secret=(value)
|
|
495
|
+
@attributes[:client_secret] = value
|
|
496
|
+
end
|
|
497
|
+
|
|
498
|
+
# string - Password for signing in to LDAP server.
|
|
499
|
+
def ldap_password
|
|
500
|
+
@attributes[:ldap_password]
|
|
501
|
+
end
|
|
502
|
+
|
|
503
|
+
def ldap_password=(value)
|
|
504
|
+
@attributes[:ldap_password] = value
|
|
505
|
+
end
|
|
506
|
+
|
|
507
|
+
# boolean - If true, the logo will be deleted.
|
|
508
|
+
def logo_delete
|
|
509
|
+
@attributes[:logo_delete]
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
def logo_delete=(value)
|
|
513
|
+
@attributes[:logo_delete] = value
|
|
514
|
+
end
|
|
515
|
+
|
|
516
|
+
# file - A logo to display on the login page.
|
|
517
|
+
def logo_file
|
|
518
|
+
@attributes[:logo_file]
|
|
519
|
+
end
|
|
520
|
+
|
|
521
|
+
def logo_file=(value)
|
|
522
|
+
@attributes[:logo_file] = value
|
|
523
|
+
end
|
|
524
|
+
|
|
525
|
+
# boolean - If true, perform a reset on SCIM OAuth access token
|
|
526
|
+
def reset_scim_oauth_access_token
|
|
527
|
+
@attributes[:reset_scim_oauth_access_token]
|
|
528
|
+
end
|
|
529
|
+
|
|
530
|
+
def reset_scim_oauth_access_token=(value)
|
|
531
|
+
@attributes[:reset_scim_oauth_access_token] = value
|
|
532
|
+
end
|
|
533
|
+
|
|
534
|
+
# string - SCIM password applicable to basic authentication.
|
|
535
|
+
def scim_password
|
|
536
|
+
@attributes[:scim_password]
|
|
537
|
+
end
|
|
538
|
+
|
|
539
|
+
def scim_password=(value)
|
|
540
|
+
@attributes[:scim_password] = value
|
|
541
|
+
end
|
|
542
|
+
|
|
272
543
|
# Synchronize provisioning data with the SSO remote server
|
|
273
544
|
def sync(params = {})
|
|
274
545
|
params ||= {}
|
|
@@ -280,6 +551,137 @@ module Files
|
|
|
280
551
|
Api.send_request("/sso_strategies/#{@attributes[:id]}/sync", :post, params, @options)
|
|
281
552
|
end
|
|
282
553
|
|
|
554
|
+
# Parameters:
|
|
555
|
+
# client_id - string - OAuth Client ID for your auth provider.
|
|
556
|
+
# client_secret - string - OAuth Client Secret for your auth provider.
|
|
557
|
+
# ldap_password - string - Password for signing in to LDAP server.
|
|
558
|
+
# logo_delete - boolean - If true, the logo will be deleted.
|
|
559
|
+
# logo_file - file - A logo to display on the login page.
|
|
560
|
+
# reset_scim_oauth_access_token - boolean - If true, perform a reset on SCIM OAuth access token
|
|
561
|
+
# scim_password - string - SCIM password applicable to basic authentication.
|
|
562
|
+
# deprovision_behavior - string - Method used for deprovisioning users.
|
|
563
|
+
# deprovision_groups - boolean - Auto-deprovision group membership based on group memberships on the SSO side?
|
|
564
|
+
# deprovision_users - boolean - Auto-deprovision users?
|
|
565
|
+
# display_on_login_page - boolean - Should this strategy be displayed on the login page?
|
|
566
|
+
# enabled - boolean - Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
567
|
+
# label - string - Custom label for the SSO provider on the login page.
|
|
568
|
+
# ldap_base_dn - string - Base DN for looking up users in LDAP server
|
|
569
|
+
# ldap_domain - string - Domain name that will be appended to LDAP usernames
|
|
570
|
+
# ldap_host - string - LDAP host
|
|
571
|
+
# ldap_host_2 - string - LDAP backup host
|
|
572
|
+
# ldap_host_3 - string - LDAP backup host
|
|
573
|
+
# ldap_port - int64 - LDAP port
|
|
574
|
+
# ldap_provisioning_enabled - boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
575
|
+
# ldap_secure - boolean - Use secure LDAP?
|
|
576
|
+
# ldap_type - string - LDAP server type
|
|
577
|
+
# ldap_username - string - Username for signing in to LDAP server.
|
|
578
|
+
# ldap_username_field - string - LDAP username field
|
|
579
|
+
# protocol - string - SSO Protocol
|
|
580
|
+
# provider - string - Provider name
|
|
581
|
+
# provider_identifier - string - URL-friendly, unique identifier for Azure SAML configuration
|
|
582
|
+
# provision_company - string - Default company for auto provisioned users.
|
|
583
|
+
# provision_dav_permission - boolean - Auto-provisioned users get WebDAV permission?
|
|
584
|
+
# provision_email_signup_groups - string - Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
585
|
+
# provision_filesystem_layout - string - File System layout to use for auto provisioned users.
|
|
586
|
+
# provision_ftp_permission - boolean - Auto-provisioned users get FTP permission?
|
|
587
|
+
# provision_group_admin_groups - string - Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
588
|
+
# provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
589
|
+
# provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
590
|
+
# provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
591
|
+
# provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
592
|
+
# provision_groups - boolean - Auto-provision group membership based on group memberships on the SSO side?
|
|
593
|
+
# provision_readonly_site_admin_groups - string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
594
|
+
# 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.
|
|
595
|
+
# provision_sftp_permission - boolean - Auto-provisioned users get SFTP permission?
|
|
596
|
+
# provision_site_admin_groups - string - Comma-separated list of group names whose members will be created as Site Admins.
|
|
597
|
+
# provision_time_zone - string - Default time zone for auto provisioned users.
|
|
598
|
+
# provision_users - boolean - Auto-provision users?
|
|
599
|
+
# saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
600
|
+
# saml_provider_issuer_url - string - Identity provider issuer url
|
|
601
|
+
# saml_provider_metadata_content - string - Custom identity provider metadata
|
|
602
|
+
# saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
|
|
603
|
+
# saml_provider_slo_target_url - string - Identity provider SLO endpoint
|
|
604
|
+
# saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
605
|
+
# scim_authentication_method - string - SCIM authentication type.
|
|
606
|
+
# scim_oauth_access_token_expires_at - string - SCIM OAuth Access Token Expiration Time.
|
|
607
|
+
# scim_username - string - SCIM username.
|
|
608
|
+
# subdomain - string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
609
|
+
def update(params = {})
|
|
610
|
+
params ||= {}
|
|
611
|
+
params[:id] = @attributes[:id]
|
|
612
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
613
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
614
|
+
raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params[:client_id] and !params[:client_id].is_a?(String)
|
|
615
|
+
raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params[:client_secret] and !params[:client_secret].is_a?(String)
|
|
616
|
+
raise InvalidParameterError.new("Bad parameter: ldap_password must be an String") if params[:ldap_password] and !params[:ldap_password].is_a?(String)
|
|
617
|
+
raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params[:scim_password] and !params[:scim_password].is_a?(String)
|
|
618
|
+
raise InvalidParameterError.new("Bad parameter: deprovision_behavior must be an String") if params[:deprovision_behavior] and !params[:deprovision_behavior].is_a?(String)
|
|
619
|
+
raise InvalidParameterError.new("Bad parameter: label must be an String") if params[:label] and !params[:label].is_a?(String)
|
|
620
|
+
raise InvalidParameterError.new("Bad parameter: ldap_base_dn must be an String") if params[:ldap_base_dn] and !params[:ldap_base_dn].is_a?(String)
|
|
621
|
+
raise InvalidParameterError.new("Bad parameter: ldap_domain must be an String") if params[:ldap_domain] and !params[:ldap_domain].is_a?(String)
|
|
622
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host must be an String") if params[:ldap_host] and !params[:ldap_host].is_a?(String)
|
|
623
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host_2 must be an String") if params[:ldap_host_2] and !params[:ldap_host_2].is_a?(String)
|
|
624
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host_3 must be an String") if params[:ldap_host_3] and !params[:ldap_host_3].is_a?(String)
|
|
625
|
+
raise InvalidParameterError.new("Bad parameter: ldap_port must be an Integer") if params[:ldap_port] and !params[:ldap_port].is_a?(Integer)
|
|
626
|
+
raise InvalidParameterError.new("Bad parameter: ldap_type must be an String") if params[:ldap_type] and !params[:ldap_type].is_a?(String)
|
|
627
|
+
raise InvalidParameterError.new("Bad parameter: ldap_username must be an String") if params[:ldap_username] and !params[:ldap_username].is_a?(String)
|
|
628
|
+
raise InvalidParameterError.new("Bad parameter: ldap_username_field must be an String") if params[:ldap_username_field] and !params[:ldap_username_field].is_a?(String)
|
|
629
|
+
raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params[:protocol] and !params[:protocol].is_a?(String)
|
|
630
|
+
raise InvalidParameterError.new("Bad parameter: provider must be an String") if params[:provider] and !params[:provider].is_a?(String)
|
|
631
|
+
raise InvalidParameterError.new("Bad parameter: provider_identifier must be an String") if params[:provider_identifier] and !params[:provider_identifier].is_a?(String)
|
|
632
|
+
raise InvalidParameterError.new("Bad parameter: provision_company must be an String") if params[:provision_company] and !params[:provision_company].is_a?(String)
|
|
633
|
+
raise InvalidParameterError.new("Bad parameter: provision_email_signup_groups must be an String") if params[:provision_email_signup_groups] and !params[:provision_email_signup_groups].is_a?(String)
|
|
634
|
+
raise InvalidParameterError.new("Bad parameter: provision_filesystem_layout must be an String") if params[:provision_filesystem_layout] and !params[:provision_filesystem_layout].is_a?(String)
|
|
635
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_admin_groups must be an String") if params[:provision_group_admin_groups] and !params[:provision_group_admin_groups].is_a?(String)
|
|
636
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_default must be an String") if params[:provision_group_default] and !params[:provision_group_default].is_a?(String)
|
|
637
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_exclusion must be an String") if params[:provision_group_exclusion] and !params[:provision_group_exclusion].is_a?(String)
|
|
638
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_inclusion must be an String") if params[:provision_group_inclusion] and !params[:provision_group_inclusion].is_a?(String)
|
|
639
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_required must be an String") if params[:provision_group_required] and !params[:provision_group_required].is_a?(String)
|
|
640
|
+
raise InvalidParameterError.new("Bad parameter: provision_readonly_site_admin_groups must be an String") if params[:provision_readonly_site_admin_groups] and !params[:provision_readonly_site_admin_groups].is_a?(String)
|
|
641
|
+
raise InvalidParameterError.new("Bad parameter: provision_require_2fa must be an String") if params[:provision_require_2fa] and !params[:provision_require_2fa].is_a?(String)
|
|
642
|
+
raise InvalidParameterError.new("Bad parameter: provision_site_admin_groups must be an String") if params[:provision_site_admin_groups] and !params[:provision_site_admin_groups].is_a?(String)
|
|
643
|
+
raise InvalidParameterError.new("Bad parameter: provision_time_zone must be an String") if params[:provision_time_zone] and !params[:provision_time_zone].is_a?(String)
|
|
644
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_cert_fingerprint must be an String") if params[:saml_provider_cert_fingerprint] and !params[:saml_provider_cert_fingerprint].is_a?(String)
|
|
645
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_issuer_url must be an String") if params[:saml_provider_issuer_url] and !params[:saml_provider_issuer_url].is_a?(String)
|
|
646
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_content must be an String") if params[:saml_provider_metadata_content] and !params[:saml_provider_metadata_content].is_a?(String)
|
|
647
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_url must be an String") if params[:saml_provider_metadata_url] and !params[:saml_provider_metadata_url].is_a?(String)
|
|
648
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_slo_target_url must be an String") if params[:saml_provider_slo_target_url] and !params[:saml_provider_slo_target_url].is_a?(String)
|
|
649
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_sso_target_url must be an String") if params[:saml_provider_sso_target_url] and !params[:saml_provider_sso_target_url].is_a?(String)
|
|
650
|
+
raise InvalidParameterError.new("Bad parameter: scim_authentication_method must be an String") if params[:scim_authentication_method] and !params[:scim_authentication_method].is_a?(String)
|
|
651
|
+
raise InvalidParameterError.new("Bad parameter: scim_oauth_access_token_expires_at must be an String") if params[:scim_oauth_access_token_expires_at] and !params[:scim_oauth_access_token_expires_at].is_a?(String)
|
|
652
|
+
raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params[:scim_username] and !params[:scim_username].is_a?(String)
|
|
653
|
+
raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
|
|
654
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
655
|
+
|
|
656
|
+
Api.send_request("/sso_strategies/#{@attributes[:id]}", :patch, params, @options)
|
|
657
|
+
end
|
|
658
|
+
|
|
659
|
+
def delete(params = {})
|
|
660
|
+
params ||= {}
|
|
661
|
+
params[:id] = @attributes[:id]
|
|
662
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
663
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
664
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
665
|
+
|
|
666
|
+
Api.send_request("/sso_strategies/#{@attributes[:id]}", :delete, params, @options)
|
|
667
|
+
end
|
|
668
|
+
|
|
669
|
+
def destroy(params = {})
|
|
670
|
+
delete(params)
|
|
671
|
+
nil
|
|
672
|
+
end
|
|
673
|
+
|
|
674
|
+
def save
|
|
675
|
+
if @attributes[:id]
|
|
676
|
+
new_obj = update(@attributes)
|
|
677
|
+
else
|
|
678
|
+
new_obj = SsoStrategy.create(@attributes, @options)
|
|
679
|
+
end
|
|
680
|
+
|
|
681
|
+
@attributes = new_obj.attributes
|
|
682
|
+
true
|
|
683
|
+
end
|
|
684
|
+
|
|
283
685
|
# Parameters:
|
|
284
686
|
# 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.
|
|
285
687
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
@@ -314,6 +716,107 @@ module Files
|
|
|
314
716
|
find(id, params, options)
|
|
315
717
|
end
|
|
316
718
|
|
|
719
|
+
# Parameters:
|
|
720
|
+
# client_id - string - OAuth Client ID for your auth provider.
|
|
721
|
+
# client_secret - string - OAuth Client Secret for your auth provider.
|
|
722
|
+
# ldap_password - string - Password for signing in to LDAP server.
|
|
723
|
+
# logo_delete - boolean - If true, the logo will be deleted.
|
|
724
|
+
# logo_file - file - A logo to display on the login page.
|
|
725
|
+
# reset_scim_oauth_access_token - boolean - If true, perform a reset on SCIM OAuth access token
|
|
726
|
+
# scim_password - string - SCIM password applicable to basic authentication.
|
|
727
|
+
# deprovision_behavior - string - Method used for deprovisioning users.
|
|
728
|
+
# deprovision_groups - boolean - Auto-deprovision group membership based on group memberships on the SSO side?
|
|
729
|
+
# deprovision_users - boolean - Auto-deprovision users?
|
|
730
|
+
# display_on_login_page - boolean - Should this strategy be displayed on the login page?
|
|
731
|
+
# enabled - boolean - Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
732
|
+
# label - string - Custom label for the SSO provider on the login page.
|
|
733
|
+
# ldap_base_dn - string - Base DN for looking up users in LDAP server
|
|
734
|
+
# ldap_domain - string - Domain name that will be appended to LDAP usernames
|
|
735
|
+
# ldap_host - string - LDAP host
|
|
736
|
+
# ldap_host_2 - string - LDAP backup host
|
|
737
|
+
# ldap_host_3 - string - LDAP backup host
|
|
738
|
+
# ldap_port - int64 - LDAP port
|
|
739
|
+
# ldap_provisioning_enabled - boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
740
|
+
# ldap_secure - boolean - Use secure LDAP?
|
|
741
|
+
# ldap_type - string - LDAP server type
|
|
742
|
+
# ldap_username - string - Username for signing in to LDAP server.
|
|
743
|
+
# ldap_username_field - string - LDAP username field
|
|
744
|
+
# protocol - string - SSO Protocol
|
|
745
|
+
# provider - string - Provider name
|
|
746
|
+
# provider_identifier - string - URL-friendly, unique identifier for Azure SAML configuration
|
|
747
|
+
# provision_company - string - Default company for auto provisioned users.
|
|
748
|
+
# provision_dav_permission - boolean - Auto-provisioned users get WebDAV permission?
|
|
749
|
+
# provision_email_signup_groups - string - Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
750
|
+
# provision_filesystem_layout - string - File System layout to use for auto provisioned users.
|
|
751
|
+
# provision_ftp_permission - boolean - Auto-provisioned users get FTP permission?
|
|
752
|
+
# provision_group_admin_groups - string - Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
753
|
+
# provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
754
|
+
# provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
755
|
+
# provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
756
|
+
# provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
757
|
+
# provision_groups - boolean - Auto-provision group membership based on group memberships on the SSO side?
|
|
758
|
+
# provision_readonly_site_admin_groups - string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
759
|
+
# 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.
|
|
760
|
+
# provision_sftp_permission - boolean - Auto-provisioned users get SFTP permission?
|
|
761
|
+
# provision_site_admin_groups - string - Comma-separated list of group names whose members will be created as Site Admins.
|
|
762
|
+
# provision_time_zone - string - Default time zone for auto provisioned users.
|
|
763
|
+
# provision_users - boolean - Auto-provision users?
|
|
764
|
+
# saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
765
|
+
# saml_provider_issuer_url - string - Identity provider issuer url
|
|
766
|
+
# saml_provider_metadata_content - string - Custom identity provider metadata
|
|
767
|
+
# saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
|
|
768
|
+
# saml_provider_slo_target_url - string - Identity provider SLO endpoint
|
|
769
|
+
# saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
770
|
+
# scim_authentication_method - string - SCIM authentication type.
|
|
771
|
+
# scim_oauth_access_token_expires_at - string - SCIM OAuth Access Token Expiration Time.
|
|
772
|
+
# scim_username - string - SCIM username.
|
|
773
|
+
# subdomain - string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
774
|
+
def self.create(params = {}, options = {})
|
|
775
|
+
raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params[:client_id] and !params[:client_id].is_a?(String)
|
|
776
|
+
raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params[:client_secret] and !params[:client_secret].is_a?(String)
|
|
777
|
+
raise InvalidParameterError.new("Bad parameter: ldap_password must be an String") if params[:ldap_password] and !params[:ldap_password].is_a?(String)
|
|
778
|
+
raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params[:scim_password] and !params[:scim_password].is_a?(String)
|
|
779
|
+
raise InvalidParameterError.new("Bad parameter: deprovision_behavior must be an String") if params[:deprovision_behavior] and !params[:deprovision_behavior].is_a?(String)
|
|
780
|
+
raise InvalidParameterError.new("Bad parameter: label must be an String") if params[:label] and !params[:label].is_a?(String)
|
|
781
|
+
raise InvalidParameterError.new("Bad parameter: ldap_base_dn must be an String") if params[:ldap_base_dn] and !params[:ldap_base_dn].is_a?(String)
|
|
782
|
+
raise InvalidParameterError.new("Bad parameter: ldap_domain must be an String") if params[:ldap_domain] and !params[:ldap_domain].is_a?(String)
|
|
783
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host must be an String") if params[:ldap_host] and !params[:ldap_host].is_a?(String)
|
|
784
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host_2 must be an String") if params[:ldap_host_2] and !params[:ldap_host_2].is_a?(String)
|
|
785
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host_3 must be an String") if params[:ldap_host_3] and !params[:ldap_host_3].is_a?(String)
|
|
786
|
+
raise InvalidParameterError.new("Bad parameter: ldap_port must be an Integer") if params[:ldap_port] and !params[:ldap_port].is_a?(Integer)
|
|
787
|
+
raise InvalidParameterError.new("Bad parameter: ldap_type must be an String") if params[:ldap_type] and !params[:ldap_type].is_a?(String)
|
|
788
|
+
raise InvalidParameterError.new("Bad parameter: ldap_username must be an String") if params[:ldap_username] and !params[:ldap_username].is_a?(String)
|
|
789
|
+
raise InvalidParameterError.new("Bad parameter: ldap_username_field must be an String") if params[:ldap_username_field] and !params[:ldap_username_field].is_a?(String)
|
|
790
|
+
raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params[:protocol] and !params[:protocol].is_a?(String)
|
|
791
|
+
raise InvalidParameterError.new("Bad parameter: provider must be an String") if params[:provider] and !params[:provider].is_a?(String)
|
|
792
|
+
raise InvalidParameterError.new("Bad parameter: provider_identifier must be an String") if params[:provider_identifier] and !params[:provider_identifier].is_a?(String)
|
|
793
|
+
raise InvalidParameterError.new("Bad parameter: provision_company must be an String") if params[:provision_company] and !params[:provision_company].is_a?(String)
|
|
794
|
+
raise InvalidParameterError.new("Bad parameter: provision_email_signup_groups must be an String") if params[:provision_email_signup_groups] and !params[:provision_email_signup_groups].is_a?(String)
|
|
795
|
+
raise InvalidParameterError.new("Bad parameter: provision_filesystem_layout must be an String") if params[:provision_filesystem_layout] and !params[:provision_filesystem_layout].is_a?(String)
|
|
796
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_admin_groups must be an String") if params[:provision_group_admin_groups] and !params[:provision_group_admin_groups].is_a?(String)
|
|
797
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_default must be an String") if params[:provision_group_default] and !params[:provision_group_default].is_a?(String)
|
|
798
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_exclusion must be an String") if params[:provision_group_exclusion] and !params[:provision_group_exclusion].is_a?(String)
|
|
799
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_inclusion must be an String") if params[:provision_group_inclusion] and !params[:provision_group_inclusion].is_a?(String)
|
|
800
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_required must be an String") if params[:provision_group_required] and !params[:provision_group_required].is_a?(String)
|
|
801
|
+
raise InvalidParameterError.new("Bad parameter: provision_readonly_site_admin_groups must be an String") if params[:provision_readonly_site_admin_groups] and !params[:provision_readonly_site_admin_groups].is_a?(String)
|
|
802
|
+
raise InvalidParameterError.new("Bad parameter: provision_require_2fa must be an String") if params[:provision_require_2fa] and !params[:provision_require_2fa].is_a?(String)
|
|
803
|
+
raise InvalidParameterError.new("Bad parameter: provision_site_admin_groups must be an String") if params[:provision_site_admin_groups] and !params[:provision_site_admin_groups].is_a?(String)
|
|
804
|
+
raise InvalidParameterError.new("Bad parameter: provision_time_zone must be an String") if params[:provision_time_zone] and !params[:provision_time_zone].is_a?(String)
|
|
805
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_cert_fingerprint must be an String") if params[:saml_provider_cert_fingerprint] and !params[:saml_provider_cert_fingerprint].is_a?(String)
|
|
806
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_issuer_url must be an String") if params[:saml_provider_issuer_url] and !params[:saml_provider_issuer_url].is_a?(String)
|
|
807
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_content must be an String") if params[:saml_provider_metadata_content] and !params[:saml_provider_metadata_content].is_a?(String)
|
|
808
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_url must be an String") if params[:saml_provider_metadata_url] and !params[:saml_provider_metadata_url].is_a?(String)
|
|
809
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_slo_target_url must be an String") if params[:saml_provider_slo_target_url] and !params[:saml_provider_slo_target_url].is_a?(String)
|
|
810
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_sso_target_url must be an String") if params[:saml_provider_sso_target_url] and !params[:saml_provider_sso_target_url].is_a?(String)
|
|
811
|
+
raise InvalidParameterError.new("Bad parameter: scim_authentication_method must be an String") if params[:scim_authentication_method] and !params[:scim_authentication_method].is_a?(String)
|
|
812
|
+
raise InvalidParameterError.new("Bad parameter: scim_oauth_access_token_expires_at must be an String") if params[:scim_oauth_access_token_expires_at] and !params[:scim_oauth_access_token_expires_at].is_a?(String)
|
|
813
|
+
raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params[:scim_username] and !params[:scim_username].is_a?(String)
|
|
814
|
+
raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
|
|
815
|
+
|
|
816
|
+
response, options = Api.send_request("/sso_strategies", :post, params, options)
|
|
817
|
+
SsoStrategy.new(response.data, options)
|
|
818
|
+
end
|
|
819
|
+
|
|
317
820
|
# Synchronize provisioning data with the SSO remote server
|
|
318
821
|
def self.sync(id, params = {}, options = {})
|
|
319
822
|
params ||= {}
|
|
@@ -324,5 +827,134 @@ module Files
|
|
|
324
827
|
Api.send_request("/sso_strategies/#{params[:id]}/sync", :post, params, options)
|
|
325
828
|
nil
|
|
326
829
|
end
|
|
830
|
+
|
|
831
|
+
# Parameters:
|
|
832
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
833
|
+
def self.create_export(params = {}, options = {})
|
|
834
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
835
|
+
|
|
836
|
+
response, options = Api.send_request("/sso_strategies/create_export", :post, params, options)
|
|
837
|
+
Export.new(response.data, options)
|
|
838
|
+
end
|
|
839
|
+
|
|
840
|
+
# Parameters:
|
|
841
|
+
# client_id - string - OAuth Client ID for your auth provider.
|
|
842
|
+
# client_secret - string - OAuth Client Secret for your auth provider.
|
|
843
|
+
# ldap_password - string - Password for signing in to LDAP server.
|
|
844
|
+
# logo_delete - boolean - If true, the logo will be deleted.
|
|
845
|
+
# logo_file - file - A logo to display on the login page.
|
|
846
|
+
# reset_scim_oauth_access_token - boolean - If true, perform a reset on SCIM OAuth access token
|
|
847
|
+
# scim_password - string - SCIM password applicable to basic authentication.
|
|
848
|
+
# deprovision_behavior - string - Method used for deprovisioning users.
|
|
849
|
+
# deprovision_groups - boolean - Auto-deprovision group membership based on group memberships on the SSO side?
|
|
850
|
+
# deprovision_users - boolean - Auto-deprovision users?
|
|
851
|
+
# display_on_login_page - boolean - Should this strategy be displayed on the login page?
|
|
852
|
+
# enabled - boolean - Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
853
|
+
# label - string - Custom label for the SSO provider on the login page.
|
|
854
|
+
# ldap_base_dn - string - Base DN for looking up users in LDAP server
|
|
855
|
+
# ldap_domain - string - Domain name that will be appended to LDAP usernames
|
|
856
|
+
# ldap_host - string - LDAP host
|
|
857
|
+
# ldap_host_2 - string - LDAP backup host
|
|
858
|
+
# ldap_host_3 - string - LDAP backup host
|
|
859
|
+
# ldap_port - int64 - LDAP port
|
|
860
|
+
# ldap_provisioning_enabled - boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
861
|
+
# ldap_secure - boolean - Use secure LDAP?
|
|
862
|
+
# ldap_type - string - LDAP server type
|
|
863
|
+
# ldap_username - string - Username for signing in to LDAP server.
|
|
864
|
+
# ldap_username_field - string - LDAP username field
|
|
865
|
+
# protocol - string - SSO Protocol
|
|
866
|
+
# provider - string - Provider name
|
|
867
|
+
# provider_identifier - string - URL-friendly, unique identifier for Azure SAML configuration
|
|
868
|
+
# provision_company - string - Default company for auto provisioned users.
|
|
869
|
+
# provision_dav_permission - boolean - Auto-provisioned users get WebDAV permission?
|
|
870
|
+
# provision_email_signup_groups - string - Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
871
|
+
# provision_filesystem_layout - string - File System layout to use for auto provisioned users.
|
|
872
|
+
# provision_ftp_permission - boolean - Auto-provisioned users get FTP permission?
|
|
873
|
+
# provision_group_admin_groups - string - Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
874
|
+
# provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
875
|
+
# provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
876
|
+
# provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
877
|
+
# provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
878
|
+
# provision_groups - boolean - Auto-provision group membership based on group memberships on the SSO side?
|
|
879
|
+
# provision_readonly_site_admin_groups - string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
880
|
+
# 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.
|
|
881
|
+
# provision_sftp_permission - boolean - Auto-provisioned users get SFTP permission?
|
|
882
|
+
# provision_site_admin_groups - string - Comma-separated list of group names whose members will be created as Site Admins.
|
|
883
|
+
# provision_time_zone - string - Default time zone for auto provisioned users.
|
|
884
|
+
# provision_users - boolean - Auto-provision users?
|
|
885
|
+
# saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
886
|
+
# saml_provider_issuer_url - string - Identity provider issuer url
|
|
887
|
+
# saml_provider_metadata_content - string - Custom identity provider metadata
|
|
888
|
+
# saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
|
|
889
|
+
# saml_provider_slo_target_url - string - Identity provider SLO endpoint
|
|
890
|
+
# saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
891
|
+
# scim_authentication_method - string - SCIM authentication type.
|
|
892
|
+
# scim_oauth_access_token_expires_at - string - SCIM OAuth Access Token Expiration Time.
|
|
893
|
+
# scim_username - string - SCIM username.
|
|
894
|
+
# subdomain - string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
895
|
+
def self.update(id, params = {}, options = {})
|
|
896
|
+
params ||= {}
|
|
897
|
+
params[:id] = id
|
|
898
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
899
|
+
raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params[:client_id] and !params[:client_id].is_a?(String)
|
|
900
|
+
raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params[:client_secret] and !params[:client_secret].is_a?(String)
|
|
901
|
+
raise InvalidParameterError.new("Bad parameter: ldap_password must be an String") if params[:ldap_password] and !params[:ldap_password].is_a?(String)
|
|
902
|
+
raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params[:scim_password] and !params[:scim_password].is_a?(String)
|
|
903
|
+
raise InvalidParameterError.new("Bad parameter: deprovision_behavior must be an String") if params[:deprovision_behavior] and !params[:deprovision_behavior].is_a?(String)
|
|
904
|
+
raise InvalidParameterError.new("Bad parameter: label must be an String") if params[:label] and !params[:label].is_a?(String)
|
|
905
|
+
raise InvalidParameterError.new("Bad parameter: ldap_base_dn must be an String") if params[:ldap_base_dn] and !params[:ldap_base_dn].is_a?(String)
|
|
906
|
+
raise InvalidParameterError.new("Bad parameter: ldap_domain must be an String") if params[:ldap_domain] and !params[:ldap_domain].is_a?(String)
|
|
907
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host must be an String") if params[:ldap_host] and !params[:ldap_host].is_a?(String)
|
|
908
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host_2 must be an String") if params[:ldap_host_2] and !params[:ldap_host_2].is_a?(String)
|
|
909
|
+
raise InvalidParameterError.new("Bad parameter: ldap_host_3 must be an String") if params[:ldap_host_3] and !params[:ldap_host_3].is_a?(String)
|
|
910
|
+
raise InvalidParameterError.new("Bad parameter: ldap_port must be an Integer") if params[:ldap_port] and !params[:ldap_port].is_a?(Integer)
|
|
911
|
+
raise InvalidParameterError.new("Bad parameter: ldap_type must be an String") if params[:ldap_type] and !params[:ldap_type].is_a?(String)
|
|
912
|
+
raise InvalidParameterError.new("Bad parameter: ldap_username must be an String") if params[:ldap_username] and !params[:ldap_username].is_a?(String)
|
|
913
|
+
raise InvalidParameterError.new("Bad parameter: ldap_username_field must be an String") if params[:ldap_username_field] and !params[:ldap_username_field].is_a?(String)
|
|
914
|
+
raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params[:protocol] and !params[:protocol].is_a?(String)
|
|
915
|
+
raise InvalidParameterError.new("Bad parameter: provider must be an String") if params[:provider] and !params[:provider].is_a?(String)
|
|
916
|
+
raise InvalidParameterError.new("Bad parameter: provider_identifier must be an String") if params[:provider_identifier] and !params[:provider_identifier].is_a?(String)
|
|
917
|
+
raise InvalidParameterError.new("Bad parameter: provision_company must be an String") if params[:provision_company] and !params[:provision_company].is_a?(String)
|
|
918
|
+
raise InvalidParameterError.new("Bad parameter: provision_email_signup_groups must be an String") if params[:provision_email_signup_groups] and !params[:provision_email_signup_groups].is_a?(String)
|
|
919
|
+
raise InvalidParameterError.new("Bad parameter: provision_filesystem_layout must be an String") if params[:provision_filesystem_layout] and !params[:provision_filesystem_layout].is_a?(String)
|
|
920
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_admin_groups must be an String") if params[:provision_group_admin_groups] and !params[:provision_group_admin_groups].is_a?(String)
|
|
921
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_default must be an String") if params[:provision_group_default] and !params[:provision_group_default].is_a?(String)
|
|
922
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_exclusion must be an String") if params[:provision_group_exclusion] and !params[:provision_group_exclusion].is_a?(String)
|
|
923
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_inclusion must be an String") if params[:provision_group_inclusion] and !params[:provision_group_inclusion].is_a?(String)
|
|
924
|
+
raise InvalidParameterError.new("Bad parameter: provision_group_required must be an String") if params[:provision_group_required] and !params[:provision_group_required].is_a?(String)
|
|
925
|
+
raise InvalidParameterError.new("Bad parameter: provision_readonly_site_admin_groups must be an String") if params[:provision_readonly_site_admin_groups] and !params[:provision_readonly_site_admin_groups].is_a?(String)
|
|
926
|
+
raise InvalidParameterError.new("Bad parameter: provision_require_2fa must be an String") if params[:provision_require_2fa] and !params[:provision_require_2fa].is_a?(String)
|
|
927
|
+
raise InvalidParameterError.new("Bad parameter: provision_site_admin_groups must be an String") if params[:provision_site_admin_groups] and !params[:provision_site_admin_groups].is_a?(String)
|
|
928
|
+
raise InvalidParameterError.new("Bad parameter: provision_time_zone must be an String") if params[:provision_time_zone] and !params[:provision_time_zone].is_a?(String)
|
|
929
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_cert_fingerprint must be an String") if params[:saml_provider_cert_fingerprint] and !params[:saml_provider_cert_fingerprint].is_a?(String)
|
|
930
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_issuer_url must be an String") if params[:saml_provider_issuer_url] and !params[:saml_provider_issuer_url].is_a?(String)
|
|
931
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_content must be an String") if params[:saml_provider_metadata_content] and !params[:saml_provider_metadata_content].is_a?(String)
|
|
932
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_url must be an String") if params[:saml_provider_metadata_url] and !params[:saml_provider_metadata_url].is_a?(String)
|
|
933
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_slo_target_url must be an String") if params[:saml_provider_slo_target_url] and !params[:saml_provider_slo_target_url].is_a?(String)
|
|
934
|
+
raise InvalidParameterError.new("Bad parameter: saml_provider_sso_target_url must be an String") if params[:saml_provider_sso_target_url] and !params[:saml_provider_sso_target_url].is_a?(String)
|
|
935
|
+
raise InvalidParameterError.new("Bad parameter: scim_authentication_method must be an String") if params[:scim_authentication_method] and !params[:scim_authentication_method].is_a?(String)
|
|
936
|
+
raise InvalidParameterError.new("Bad parameter: scim_oauth_access_token_expires_at must be an String") if params[:scim_oauth_access_token_expires_at] and !params[:scim_oauth_access_token_expires_at].is_a?(String)
|
|
937
|
+
raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params[:scim_username] and !params[:scim_username].is_a?(String)
|
|
938
|
+
raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
|
|
939
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
940
|
+
|
|
941
|
+
response, options = Api.send_request("/sso_strategies/#{params[:id]}", :patch, params, options)
|
|
942
|
+
SsoStrategy.new(response.data, options)
|
|
943
|
+
end
|
|
944
|
+
|
|
945
|
+
def self.delete(id, params = {}, options = {})
|
|
946
|
+
params ||= {}
|
|
947
|
+
params[:id] = id
|
|
948
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
949
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
950
|
+
|
|
951
|
+
Api.send_request("/sso_strategies/#{params[:id]}", :delete, params, options)
|
|
952
|
+
nil
|
|
953
|
+
end
|
|
954
|
+
|
|
955
|
+
def self.destroy(id, params = {}, options = {})
|
|
956
|
+
delete(id, params, options)
|
|
957
|
+
nil
|
|
958
|
+
end
|
|
327
959
|
end
|
|
328
960
|
end
|