files.com 1.1.671 → 1.1.673
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/action_log.md +1 -21
- data/docs/action_notification_export_result.md +0 -17
- data/docs/ai_assistant_personality.md +0 -14
- data/docs/ai_task.md +0 -14
- data/docs/api_key.md +1 -27
- data/docs/api_request_log.md +1 -21
- data/docs/app.md +0 -15
- data/docs/as2_incoming_message.md +0 -18
- data/docs/as2_outgoing_message.md +0 -18
- data/docs/as2_partner.md +0 -14
- data/docs/as2_station.md +0 -14
- data/docs/automation.md +1 -22
- data/docs/automation_log.md +1 -21
- data/docs/automation_run.md +0 -19
- data/docs/bandwidth_snapshot.md +0 -18
- data/docs/behavior.md +0 -14
- data/docs/bundle.md +1 -50
- data/docs/bundle_action.md +0 -25
- data/docs/bundle_download.md +0 -23
- data/docs/bundle_notification.md +0 -19
- data/docs/bundle_recipient.md +0 -21
- data/docs/bundle_registration.md +0 -61
- data/docs/chat_session.md +2 -14
- data/docs/child_site_management_policy.md +0 -9
- data/docs/clickwrap.md +0 -13
- data/docs/custom_domain.md +0 -13
- data/docs/desktop_configuration_profile.md +0 -14
- data/docs/dns_record.md +0 -9
- data/docs/email_incoming_message.md +0 -19
- data/docs/email_log.md +1 -20
- data/docs/event_channel.md +0 -14
- data/docs/event_delivery_attempt.md +0 -14
- data/docs/event_record.md +0 -19
- data/docs/event_subscription.md +0 -14
- data/docs/event_target.md +0 -14
- data/docs/exavault_api_request_log.md +1 -21
- data/docs/expectation.md +0 -14
- data/docs/expectation_evaluation.md +0 -14
- data/docs/expectation_incident.md +0 -14
- data/docs/external_event.md +0 -18
- data/docs/file.md +2 -90
- data/docs/file_migration.md +0 -32
- data/docs/file_migration_log.md +1 -20
- data/docs/file_upload_part.md +1 -3
- data/docs/folder.md +0 -20
- data/docs/form_field_set.md +0 -15
- data/docs/ftp_action_log.md +1 -21
- data/docs/gpg_key.md +0 -21
- data/docs/group.md +0 -19
- data/docs/group_user.md +2 -22
- data/docs/history.md +0 -85
- data/docs/history_export_result.md +0 -17
- data/docs/holiday_region.md +0 -9
- data/docs/inbound_s3_log.md +1 -21
- data/docs/inbox_recipient.md +0 -19
- data/docs/inbox_registration.md +0 -57
- data/docs/inbox_upload.md +0 -18
- data/docs/invoice.md +0 -9
- data/docs/ip_address.md +0 -59
- data/docs/key_lifecycle_rule.md +0 -14
- data/docs/lock.md +0 -15
- data/docs/message.md +0 -17
- data/docs/message_comment.md +0 -18
- data/docs/message_comment_reaction.md +0 -18
- data/docs/message_reaction.md +0 -17
- data/docs/metadata_category.md +0 -13
- data/docs/notification.md +0 -20
- data/docs/outbound_connection_log.md +1 -21
- data/docs/partner.md +0 -14
- data/docs/partner_channel.md +0 -14
- data/docs/partner_site_request.md +0 -14
- data/docs/payment.md +0 -9
- data/docs/pending_work_event.md +0 -18
- data/docs/permission.md +0 -22
- data/docs/preview.md +0 -57
- data/docs/project.md +0 -9
- data/docs/public_hosting_request_log.md +1 -21
- data/docs/public_key.md +0 -21
- data/docs/remote_bandwidth_snapshot.md +0 -18
- data/docs/remote_mount_backend.md +0 -13
- data/docs/remote_server.md +0 -233
- data/docs/remote_server_credential.md +0 -15
- data/docs/request.md +0 -17
- data/docs/restore.md +0 -14
- data/docs/scheduled_export.md +0 -15
- data/docs/scim_log.md +0 -13
- data/docs/session.md +1 -232
- data/docs/settings_change.md +0 -16
- data/docs/sftp_action_log.md +1 -21
- data/docs/sftp_host_key.md +0 -9
- data/docs/share_group.md +0 -15
- data/docs/siem_http_destination.md +0 -9
- data/docs/siem_http_destination_event.md +0 -18
- data/docs/site.md +0 -179
- data/docs/site_subdomain_redirect.md +0 -13
- data/docs/snapshot.md +0 -9
- data/docs/sso_event.md +0 -19
- data/docs/sso_strategy.md +0 -406
- data/docs/sync.md +0 -14
- data/docs/sync_log.md +1 -20
- data/docs/sync_run.md +0 -21
- data/docs/usage_daily_snapshot.md +0 -18
- data/docs/usage_snapshot.md +0 -9
- data/docs/user.md +2 -49
- data/docs/user_cipher_use.md +0 -21
- data/docs/user_lifecycle_rule.md +0 -14
- data/docs/user_request.md +0 -9
- data/docs/user_security_event.md +0 -18
- data/docs/user_sftp_client_use.md +0 -15
- data/docs/web_dav_action_log.md +1 -21
- data/docs/workspace.md +0 -15
- data/lib/files.com/models/action_log.rb +0 -24
- data/lib/files.com/models/action_notification_export_result.rb +0 -12
- data/lib/files.com/models/ai_assistant_personality.rb +0 -11
- data/lib/files.com/models/ai_task.rb +0 -11
- data/lib/files.com/models/api_key.rb +5 -39
- data/lib/files.com/models/api_request_log.rb +0 -24
- data/lib/files.com/models/app.rb +0 -13
- data/lib/files.com/models/as2_incoming_message.rb +0 -19
- data/lib/files.com/models/as2_outgoing_message.rb +0 -19
- data/lib/files.com/models/as2_partner.rb +0 -11
- data/lib/files.com/models/as2_station.rb +0 -11
- data/lib/files.com/models/automation.rb +0 -30
- data/lib/files.com/models/automation_log.rb +0 -24
- data/lib/files.com/models/automation_run.rb +0 -16
- data/lib/files.com/models/bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/behavior.rb +0 -11
- data/lib/files.com/models/bundle.rb +0 -52
- data/lib/files.com/models/bundle_action.rb +0 -25
- data/lib/files.com/models/bundle_download.rb +0 -23
- data/lib/files.com/models/bundle_notification.rb +0 -15
- data/lib/files.com/models/bundle_recipient.rb +0 -27
- data/lib/files.com/models/bundle_registration.rb +0 -125
- data/lib/files.com/models/chat_session.rb +5 -11
- data/lib/files.com/models/child_site_management_policy.rb +0 -5
- data/lib/files.com/models/clickwrap.rb +0 -9
- data/lib/files.com/models/custom_domain.rb +0 -9
- data/lib/files.com/models/desktop_configuration_profile.rb +0 -11
- data/lib/files.com/models/dns_record.rb +0 -5
- data/lib/files.com/models/email_incoming_message.rb +0 -21
- data/lib/files.com/models/email_log.rb +0 -22
- data/lib/files.com/models/event_channel.rb +0 -11
- data/lib/files.com/models/event_delivery_attempt.rb +0 -11
- data/lib/files.com/models/event_record.rb +0 -21
- data/lib/files.com/models/event_subscription.rb +0 -11
- data/lib/files.com/models/event_target.rb +0 -11
- data/lib/files.com/models/exavault_api_request_log.rb +0 -24
- data/lib/files.com/models/expectation.rb +0 -11
- data/lib/files.com/models/expectation_evaluation.rb +0 -11
- data/lib/files.com/models/expectation_incident.rb +0 -11
- data/lib/files.com/models/external_event.rb +0 -19
- data/lib/files.com/models/file.rb +67 -207
- data/lib/files.com/models/file_migration.rb +0 -27
- data/lib/files.com/models/file_migration_log.rb +0 -22
- data/lib/files.com/models/file_upload_part.rb +0 -5
- data/lib/files.com/models/folder.rb +0 -69
- data/lib/files.com/models/form_field_set.rb +0 -9
- data/lib/files.com/models/ftp_action_log.rb +0 -24
- data/lib/files.com/models/gpg_key.rb +0 -21
- data/lib/files.com/models/group.rb +0 -16
- data/lib/files.com/models/group_user.rb +1 -21
- data/lib/files.com/models/history.rb +0 -94
- data/lib/files.com/models/history_export_result.rb +0 -12
- data/lib/files.com/models/holiday_region.rb +0 -5
- data/lib/files.com/models/inbound_s3_log.rb +0 -24
- data/lib/files.com/models/inbox_recipient.rb +0 -25
- data/lib/files.com/models/inbox_registration.rb +0 -121
- data/lib/files.com/models/inbox_upload.rb +0 -19
- data/lib/files.com/models/invoice.rb +0 -5
- data/lib/files.com/models/ip_address.rb +0 -37
- data/lib/files.com/models/key_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/lock.rb +0 -27
- data/lib/files.com/models/message.rb +0 -12
- data/lib/files.com/models/message_comment.rb +0 -14
- data/lib/files.com/models/message_comment_reaction.rb +0 -14
- data/lib/files.com/models/message_reaction.rb +0 -12
- data/lib/files.com/models/metadata_category.rb +0 -9
- data/lib/files.com/models/notification.rb +0 -18
- data/lib/files.com/models/outbound_connection_log.rb +0 -24
- data/lib/files.com/models/partner.rb +0 -11
- data/lib/files.com/models/partner_channel.rb +0 -11
- data/lib/files.com/models/partner_site_request.rb +0 -11
- data/lib/files.com/models/payment.rb +0 -5
- data/lib/files.com/models/pending_work_event.rb +0 -19
- data/lib/files.com/models/permission.rb +0 -22
- data/lib/files.com/models/preview.rb +0 -57
- data/lib/files.com/models/project.rb +0 -5
- data/lib/files.com/models/public_hosting_request_log.rb +0 -24
- data/lib/files.com/models/public_key.rb +0 -21
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/remote_mount_backend.rb +0 -9
- data/lib/files.com/models/remote_server.rb +0 -297
- data/lib/files.com/models/remote_server_credential.rb +0 -13
- data/lib/files.com/models/request.rb +0 -12
- data/lib/files.com/models/restore.rb +0 -11
- data/lib/files.com/models/scheduled_export.rb +0 -13
- data/lib/files.com/models/scim_log.rb +0 -9
- data/lib/files.com/models/session.rb +0 -493
- data/lib/files.com/models/settings_change.rb +0 -16
- data/lib/files.com/models/sftp_action_log.rb +0 -24
- data/lib/files.com/models/sftp_host_key.rb +0 -5
- data/lib/files.com/models/share_group.rb +0 -9
- data/lib/files.com/models/siem_http_destination.rb +0 -5
- data/lib/files.com/models/siem_http_destination_event.rb +0 -19
- data/lib/files.com/models/site.rb +0 -1021
- data/lib/files.com/models/site_subdomain_redirect.rb +0 -9
- data/lib/files.com/models/snapshot.rb +0 -5
- data/lib/files.com/models/sso_event.rb +0 -21
- data/lib/files.com/models/sso_strategy.rb +0 -632
- data/lib/files.com/models/sync.rb +0 -11
- data/lib/files.com/models/sync_log.rb +0 -22
- data/lib/files.com/models/sync_run.rb +0 -21
- data/lib/files.com/models/usage_daily_snapshot.rb +0 -19
- data/lib/files.com/models/usage_snapshot.rb +0 -5
- data/lib/files.com/models/user.rb +0 -59
- data/lib/files.com/models/user_cipher_use.rb +0 -21
- data/lib/files.com/models/user_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/user_request.rb +0 -5
- data/lib/files.com/models/user_security_event.rb +0 -19
- data/lib/files.com/models/user_sftp_client_use.rb +0 -9
- data/lib/files.com/models/web_dav_action_log.rb +0 -24
- data/lib/files.com/models/workspace.rb +0 -13
- data/lib/files.com/path_util.rb +1 -1
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +0 -59
- data/shared/normalization_for_comparison_test_data.json +3 -1
- data/spec/models/file_underscore_destinations_spec.rb +24 -0
- data/spec/path_util_spec.rb +5 -0
- metadata +2 -119
- data/docs/account.md +0 -155
- data/docs/action_webhook_failure.md +0 -28
- data/docs/agent_proxy_identity.md +0 -49
- data/docs/agent_proxy_identity_endpoint.md +0 -11
- data/docs/agent_proxy_identity_result.md +0 -24
- data/docs/agent_v2_auth.md +0 -17
- data/docs/announcement.md +0 -57
- data/docs/blog_post.md +0 -57
- data/docs/bundle_recipient_registration.md +0 -39
- data/docs/certificate.md +0 -258
- data/docs/child_site.md +0 -583
- data/docs/clickwrap_acceptance.md +0 -30
- data/docs/client_log.md +0 -17
- data/docs/crash_report.md +0 -50
- data/docs/custom_domain_for_proxy.md +0 -23
- data/docs/email_preference.md +0 -108
- data/docs/email_preference_bundle_notification.md +0 -15
- data/docs/email_preference_notification.md +0 -17
- data/docs/export.md +0 -90
- data/docs/front_end_server.md +0 -111
- data/docs/frontend_metric.md +0 -34
- data/docs/inbox.md +0 -102
- data/docs/inbox_recipient_registration.md +0 -35
- data/docs/ip.md +0 -63
- data/docs/ip_abuse_entry.md +0 -47
- data/docs/label.md +0 -9
- data/docs/lead.md +0 -161
- data/docs/monitoring_stat.md +0 -38
- data/docs/monitoring_stats.md +0 -15
- data/docs/mover_package.md +0 -68
- data/docs/nps_response.md +0 -75
- data/docs/oauth_redirect.md +0 -11
- data/docs/paired_api_key.md +0 -19
- data/docs/paypal_express_info.md +0 -31
- data/docs/paypal_express_url.md +0 -11
- data/docs/plan.md +0 -107
- data/docs/public_hosting_session_pairing.md +0 -15
- data/docs/public_inbox.md +0 -121
- data/docs/public_url.md +0 -59
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +0 -83
- data/docs/release_package.md +0 -19
- data/docs/revision.md +0 -40
- data/docs/safe_plan.md +0 -0
- data/docs/session_available_site.md +0 -26
- data/docs/setting.md +0 -33
- data/docs/settings.md +0 -498
- data/docs/ssl_certificate.md +0 -37
- data/docs/staging_site.md +0 -591
- data/docs/support_request.md +0 -126
- data/docs/sync_api_usage_snapshot.md +0 -23
- data/docs/sync_api_usage_snapshot_report.md +0 -71
- data/docs/sync_bandwidth_snapshot.md +0 -48
- data/docs/two_factor_authentication_method.md +0 -169
- data/docs/warning.md +0 -36
- data/docs/webauthn_sign_request.md +0 -13
- data/docs/zip_download.md +0 -32
- data/docs/zip_download_file.md +0 -45
- data/docs/zip_download_files.md +0 -23
- data/lib/files.com/models/account.rb +0 -346
- data/lib/files.com/models/action_webhook_failure.rb +0 -34
- data/lib/files.com/models/agent_proxy_identity.rb +0 -47
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +0 -17
- data/lib/files.com/models/agent_proxy_identity_result.rb +0 -27
- data/lib/files.com/models/agent_v2_auth.rb +0 -32
- data/lib/files.com/models/announcement.rb +0 -89
- data/lib/files.com/models/blog_post.rb +0 -84
- data/lib/files.com/models/bundle_recipient_registration.rb +0 -105
- data/lib/files.com/models/certificate.rb +0 -455
- data/lib/files.com/models/child_site.rb +0 -1756
- data/lib/files.com/models/clickwrap_acceptance.rb +0 -56
- data/lib/files.com/models/client_log.rb +0 -25
- data/lib/files.com/models/crash_report.rb +0 -151
- data/lib/files.com/models/custom_domain_for_proxy.rb +0 -47
- data/lib/files.com/models/email_preference.rb +0 -124
- data/lib/files.com/models/email_preference_bundle_notification.rb +0 -27
- data/lib/files.com/models/email_preference_notification.rb +0 -32
- data/lib/files.com/models/export.rb +0 -153
- data/lib/files.com/models/front_end_server.rb +0 -335
- data/lib/files.com/models/frontend_metric.rb +0 -65
- data/lib/files.com/models/inbox.rb +0 -123
- data/lib/files.com/models/inbox_recipient_registration.rb +0 -87
- data/lib/files.com/models/ip.rb +0 -82
- data/lib/files.com/models/ip_abuse_entry.rb +0 -96
- data/lib/files.com/models/label.rb +0 -22
- data/lib/files.com/models/lead.rb +0 -434
- data/lib/files.com/models/monitoring_stat.rb +0 -43
- data/lib/files.com/models/monitoring_stats.rb +0 -22
- data/lib/files.com/models/mover_package.rb +0 -80
- data/lib/files.com/models/nps_response.rb +0 -128
- data/lib/files.com/models/oauth_redirect.rb +0 -17
- data/lib/files.com/models/paired_api_key.rb +0 -37
- data/lib/files.com/models/paypal_express_info.rb +0 -67
- data/lib/files.com/models/paypal_express_url.rb +0 -17
- data/lib/files.com/models/plan.rb +0 -209
- data/lib/files.com/models/public_hosting_session_pairing.rb +0 -27
- data/lib/files.com/models/public_inbox.rb +0 -142
- data/lib/files.com/models/public_url.rb +0 -177
- data/lib/files.com/models/regional_migration.rb +0 -12
- data/lib/files.com/models/release.rb +0 -153
- data/lib/files.com/models/release_package.rb +0 -37
- data/lib/files.com/models/revision.rb +0 -53
- data/lib/files.com/models/safe_plan.rb +0 -12
- data/lib/files.com/models/session_available_site.rb +0 -47
- data/lib/files.com/models/setting.rb +0 -36
- data/lib/files.com/models/settings.rb +0 -1072
- data/lib/files.com/models/ssl_certificate.rb +0 -77
- data/lib/files.com/models/staging_site.rb +0 -1781
- data/lib/files.com/models/support_request.rb +0 -209
- data/lib/files.com/models/sync_api_usage_snapshot.rb +0 -47
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +0 -162
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +0 -104
- data/lib/files.com/models/two_factor_authentication_method.rb +0 -250
- data/lib/files.com/models/warning.rb +0 -38
- data/lib/files.com/models/webauthn_sign_request.rb +0 -17
- data/lib/files.com/models/zip_download.rb +0 -73
- data/lib/files.com/models/zip_download_file.rb +0 -111
- data/lib/files.com/models/zip_download_files.rb +0 -42
|
@@ -14,532 +14,261 @@ module Files
|
|
|
14
14
|
@attributes[:protocol]
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
def protocol=(value)
|
|
18
|
-
@attributes[:protocol] = value
|
|
19
|
-
end
|
|
20
|
-
|
|
21
17
|
# string - Provider name
|
|
22
18
|
def provider
|
|
23
19
|
@attributes[:provider]
|
|
24
20
|
end
|
|
25
21
|
|
|
26
|
-
def provider=(value)
|
|
27
|
-
@attributes[:provider] = value
|
|
28
|
-
end
|
|
29
|
-
|
|
30
22
|
# string - Custom label for the SSO provider on the login page.
|
|
31
23
|
def label
|
|
32
24
|
@attributes[:label]
|
|
33
25
|
end
|
|
34
26
|
|
|
35
|
-
def label=(value)
|
|
36
|
-
@attributes[:label] = value
|
|
37
|
-
end
|
|
38
|
-
|
|
39
27
|
# string - URL holding a custom logo for the SSO provider on the login page.
|
|
40
28
|
def logo_url
|
|
41
29
|
@attributes[:logo_url]
|
|
42
30
|
end
|
|
43
31
|
|
|
44
|
-
def logo_url=(value)
|
|
45
|
-
@attributes[:logo_url] = value
|
|
46
|
-
end
|
|
47
|
-
|
|
48
32
|
# int64 - ID
|
|
49
33
|
def id
|
|
50
34
|
@attributes[:id]
|
|
51
35
|
end
|
|
52
36
|
|
|
53
|
-
def id=(value)
|
|
54
|
-
@attributes[:id] = value
|
|
55
|
-
end
|
|
56
|
-
|
|
57
37
|
# int64 - Count of users with this SSO Strategy
|
|
58
38
|
def user_count
|
|
59
39
|
@attributes[:user_count]
|
|
60
40
|
end
|
|
61
41
|
|
|
62
|
-
def user_count=(value)
|
|
63
|
-
@attributes[:user_count] = value
|
|
64
|
-
end
|
|
65
|
-
|
|
66
42
|
# string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
|
67
43
|
def saml_provider_cert_fingerprint
|
|
68
44
|
@attributes[:saml_provider_cert_fingerprint]
|
|
69
45
|
end
|
|
70
46
|
|
|
71
|
-
def saml_provider_cert_fingerprint=(value)
|
|
72
|
-
@attributes[:saml_provider_cert_fingerprint] = value
|
|
73
|
-
end
|
|
74
|
-
|
|
75
47
|
# string - Identity provider issuer url
|
|
76
48
|
def saml_provider_issuer_url
|
|
77
49
|
@attributes[:saml_provider_issuer_url]
|
|
78
50
|
end
|
|
79
51
|
|
|
80
|
-
def saml_provider_issuer_url=(value)
|
|
81
|
-
@attributes[:saml_provider_issuer_url] = value
|
|
82
|
-
end
|
|
83
|
-
|
|
84
52
|
# string - Custom identity provider metadata
|
|
85
53
|
def saml_provider_metadata_content
|
|
86
54
|
@attributes[:saml_provider_metadata_content]
|
|
87
55
|
end
|
|
88
56
|
|
|
89
|
-
def saml_provider_metadata_content=(value)
|
|
90
|
-
@attributes[:saml_provider_metadata_content] = value
|
|
91
|
-
end
|
|
92
|
-
|
|
93
57
|
# string - Metadata URL for the SAML identity provider
|
|
94
58
|
def saml_provider_metadata_url
|
|
95
59
|
@attributes[:saml_provider_metadata_url]
|
|
96
60
|
end
|
|
97
61
|
|
|
98
|
-
def saml_provider_metadata_url=(value)
|
|
99
|
-
@attributes[:saml_provider_metadata_url] = value
|
|
100
|
-
end
|
|
101
|
-
|
|
102
62
|
# string - Identity provider SLO endpoint
|
|
103
63
|
def saml_provider_slo_target_url
|
|
104
64
|
@attributes[:saml_provider_slo_target_url]
|
|
105
65
|
end
|
|
106
66
|
|
|
107
|
-
def saml_provider_slo_target_url=(value)
|
|
108
|
-
@attributes[:saml_provider_slo_target_url] = value
|
|
109
|
-
end
|
|
110
|
-
|
|
111
67
|
# string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
|
112
68
|
def saml_provider_sso_target_url
|
|
113
69
|
@attributes[:saml_provider_sso_target_url]
|
|
114
70
|
end
|
|
115
71
|
|
|
116
|
-
def saml_provider_sso_target_url=(value)
|
|
117
|
-
@attributes[:saml_provider_sso_target_url] = value
|
|
118
|
-
end
|
|
119
|
-
|
|
120
72
|
# string - SCIM authentication type.
|
|
121
73
|
def scim_authentication_method
|
|
122
74
|
@attributes[:scim_authentication_method]
|
|
123
75
|
end
|
|
124
76
|
|
|
125
|
-
def scim_authentication_method=(value)
|
|
126
|
-
@attributes[:scim_authentication_method] = value
|
|
127
|
-
end
|
|
128
|
-
|
|
129
77
|
# string - SCIM username.
|
|
130
78
|
def scim_username
|
|
131
79
|
@attributes[:scim_username]
|
|
132
80
|
end
|
|
133
81
|
|
|
134
|
-
def scim_username=(value)
|
|
135
|
-
@attributes[:scim_username] = value
|
|
136
|
-
end
|
|
137
|
-
|
|
138
82
|
# string - SCIM OAuth Access Token.
|
|
139
83
|
def scim_oauth_access_token
|
|
140
84
|
@attributes[:scim_oauth_access_token]
|
|
141
85
|
end
|
|
142
86
|
|
|
143
|
-
def scim_oauth_access_token=(value)
|
|
144
|
-
@attributes[:scim_oauth_access_token] = value
|
|
145
|
-
end
|
|
146
|
-
|
|
147
87
|
# string - SCIM OAuth Access Token Expiration Time.
|
|
148
88
|
def scim_oauth_access_token_expires_at
|
|
149
89
|
@attributes[:scim_oauth_access_token_expires_at]
|
|
150
90
|
end
|
|
151
91
|
|
|
152
|
-
def scim_oauth_access_token_expires_at=(value)
|
|
153
|
-
@attributes[:scim_oauth_access_token_expires_at] = value
|
|
154
|
-
end
|
|
155
|
-
|
|
156
92
|
# string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
157
93
|
def subdomain
|
|
158
94
|
@attributes[:subdomain]
|
|
159
95
|
end
|
|
160
96
|
|
|
161
|
-
def subdomain=(value)
|
|
162
|
-
@attributes[:subdomain] = value
|
|
163
|
-
end
|
|
164
|
-
|
|
165
97
|
# boolean - Auto-provision users?
|
|
166
98
|
def provision_users
|
|
167
99
|
@attributes[:provision_users]
|
|
168
100
|
end
|
|
169
101
|
|
|
170
|
-
def provision_users=(value)
|
|
171
|
-
@attributes[:provision_users] = value
|
|
172
|
-
end
|
|
173
|
-
|
|
174
102
|
# boolean - Auto-provision group membership based on group memberships on the SSO side?
|
|
175
103
|
def provision_groups
|
|
176
104
|
@attributes[:provision_groups]
|
|
177
105
|
end
|
|
178
106
|
|
|
179
|
-
def provision_groups=(value)
|
|
180
|
-
@attributes[:provision_groups] = value
|
|
181
|
-
end
|
|
182
|
-
|
|
183
107
|
# boolean - Auto-deprovision users?
|
|
184
108
|
def deprovision_users
|
|
185
109
|
@attributes[:deprovision_users]
|
|
186
110
|
end
|
|
187
111
|
|
|
188
|
-
def deprovision_users=(value)
|
|
189
|
-
@attributes[:deprovision_users] = value
|
|
190
|
-
end
|
|
191
|
-
|
|
192
112
|
# boolean - Auto-deprovision group membership based on group memberships on the SSO side?
|
|
193
113
|
def deprovision_groups
|
|
194
114
|
@attributes[:deprovision_groups]
|
|
195
115
|
end
|
|
196
116
|
|
|
197
|
-
def deprovision_groups=(value)
|
|
198
|
-
@attributes[:deprovision_groups] = value
|
|
199
|
-
end
|
|
200
|
-
|
|
201
117
|
# string - Method used for deprovisioning users.
|
|
202
118
|
def deprovision_behavior
|
|
203
119
|
@attributes[:deprovision_behavior]
|
|
204
120
|
end
|
|
205
121
|
|
|
206
|
-
def deprovision_behavior=(value)
|
|
207
|
-
@attributes[:deprovision_behavior] = value
|
|
208
|
-
end
|
|
209
|
-
|
|
210
122
|
# string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
|
211
123
|
def provision_group_default
|
|
212
124
|
@attributes[:provision_group_default]
|
|
213
125
|
end
|
|
214
126
|
|
|
215
|
-
def provision_group_default=(value)
|
|
216
|
-
@attributes[:provision_group_default] = value
|
|
217
|
-
end
|
|
218
|
-
|
|
219
127
|
# string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
|
220
128
|
def provision_group_exclusion
|
|
221
129
|
@attributes[:provision_group_exclusion]
|
|
222
130
|
end
|
|
223
131
|
|
|
224
|
-
def provision_group_exclusion=(value)
|
|
225
|
-
@attributes[:provision_group_exclusion] = value
|
|
226
|
-
end
|
|
227
|
-
|
|
228
132
|
# string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
|
229
133
|
def provision_group_inclusion
|
|
230
134
|
@attributes[:provision_group_inclusion]
|
|
231
135
|
end
|
|
232
136
|
|
|
233
|
-
def provision_group_inclusion=(value)
|
|
234
|
-
@attributes[:provision_group_inclusion] = value
|
|
235
|
-
end
|
|
236
|
-
|
|
237
137
|
# string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
|
238
138
|
def provision_group_required
|
|
239
139
|
@attributes[:provision_group_required]
|
|
240
140
|
end
|
|
241
141
|
|
|
242
|
-
def provision_group_required=(value)
|
|
243
|
-
@attributes[:provision_group_required] = value
|
|
244
|
-
end
|
|
245
|
-
|
|
246
142
|
# string - Comma-separated list of group names whose members will be created with email_signup authentication.
|
|
247
143
|
def provision_email_signup_groups
|
|
248
144
|
@attributes[:provision_email_signup_groups]
|
|
249
145
|
end
|
|
250
146
|
|
|
251
|
-
def provision_email_signup_groups=(value)
|
|
252
|
-
@attributes[:provision_email_signup_groups] = value
|
|
253
|
-
end
|
|
254
|
-
|
|
255
147
|
# string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
|
|
256
148
|
def provision_readonly_site_admin_groups
|
|
257
149
|
@attributes[:provision_readonly_site_admin_groups]
|
|
258
150
|
end
|
|
259
151
|
|
|
260
|
-
def provision_readonly_site_admin_groups=(value)
|
|
261
|
-
@attributes[:provision_readonly_site_admin_groups] = value
|
|
262
|
-
end
|
|
263
|
-
|
|
264
152
|
# string - Comma-separated list of group names whose members will be created as Site Admins.
|
|
265
153
|
def provision_site_admin_groups
|
|
266
154
|
@attributes[:provision_site_admin_groups]
|
|
267
155
|
end
|
|
268
156
|
|
|
269
|
-
def provision_site_admin_groups=(value)
|
|
270
|
-
@attributes[:provision_site_admin_groups] = value
|
|
271
|
-
end
|
|
272
|
-
|
|
273
157
|
# string - Comma-separated list of group names whose members will be provisioned as Group Admins.
|
|
274
158
|
def provision_group_admin_groups
|
|
275
159
|
@attributes[:provision_group_admin_groups]
|
|
276
160
|
end
|
|
277
161
|
|
|
278
|
-
def provision_group_admin_groups=(value)
|
|
279
|
-
@attributes[:provision_group_admin_groups] = value
|
|
280
|
-
end
|
|
281
|
-
|
|
282
162
|
# boolean
|
|
283
163
|
def provision_attachments_permission
|
|
284
164
|
@attributes[:provision_attachments_permission]
|
|
285
165
|
end
|
|
286
166
|
|
|
287
|
-
def provision_attachments_permission=(value)
|
|
288
|
-
@attributes[:provision_attachments_permission] = value
|
|
289
|
-
end
|
|
290
|
-
|
|
291
167
|
# boolean - Auto-provisioned users get WebDAV permission?
|
|
292
168
|
def provision_dav_permission
|
|
293
169
|
@attributes[:provision_dav_permission]
|
|
294
170
|
end
|
|
295
171
|
|
|
296
|
-
def provision_dav_permission=(value)
|
|
297
|
-
@attributes[:provision_dav_permission] = value
|
|
298
|
-
end
|
|
299
|
-
|
|
300
172
|
# boolean - Auto-provisioned users get FTP permission?
|
|
301
173
|
def provision_ftp_permission
|
|
302
174
|
@attributes[:provision_ftp_permission]
|
|
303
175
|
end
|
|
304
176
|
|
|
305
|
-
def provision_ftp_permission=(value)
|
|
306
|
-
@attributes[:provision_ftp_permission] = value
|
|
307
|
-
end
|
|
308
|
-
|
|
309
177
|
# boolean - Auto-provisioned users get SFTP permission?
|
|
310
178
|
def provision_sftp_permission
|
|
311
179
|
@attributes[:provision_sftp_permission]
|
|
312
180
|
end
|
|
313
181
|
|
|
314
|
-
def provision_sftp_permission=(value)
|
|
315
|
-
@attributes[:provision_sftp_permission] = value
|
|
316
|
-
end
|
|
317
|
-
|
|
318
182
|
# string - Default time zone for auto provisioned users.
|
|
319
183
|
def provision_time_zone
|
|
320
184
|
@attributes[:provision_time_zone]
|
|
321
185
|
end
|
|
322
186
|
|
|
323
|
-
def provision_time_zone=(value)
|
|
324
|
-
@attributes[:provision_time_zone] = value
|
|
325
|
-
end
|
|
326
|
-
|
|
327
187
|
# string - Default company for auto provisioned users.
|
|
328
188
|
def provision_company
|
|
329
189
|
@attributes[:provision_company]
|
|
330
190
|
end
|
|
331
191
|
|
|
332
|
-
def provision_company=(value)
|
|
333
|
-
@attributes[:provision_company] = value
|
|
334
|
-
end
|
|
335
|
-
|
|
336
192
|
# 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.
|
|
337
193
|
def provision_require_2fa
|
|
338
194
|
@attributes[:provision_require_2fa]
|
|
339
195
|
end
|
|
340
196
|
|
|
341
|
-
def provision_require_2fa=(value)
|
|
342
|
-
@attributes[:provision_require_2fa] = value
|
|
343
|
-
end
|
|
344
|
-
|
|
345
197
|
# string - File System layout to use for auto provisioned users.
|
|
346
198
|
def provision_filesystem_layout
|
|
347
199
|
@attributes[:provision_filesystem_layout]
|
|
348
200
|
end
|
|
349
201
|
|
|
350
|
-
def provision_filesystem_layout=(value)
|
|
351
|
-
@attributes[:provision_filesystem_layout] = value
|
|
352
|
-
end
|
|
353
|
-
|
|
354
202
|
# string - URL-friendly, unique identifier for Azure SAML configuration
|
|
355
203
|
def provider_identifier
|
|
356
204
|
@attributes[:provider_identifier]
|
|
357
205
|
end
|
|
358
206
|
|
|
359
|
-
def provider_identifier=(value)
|
|
360
|
-
@attributes[:provider_identifier] = value
|
|
361
|
-
end
|
|
362
|
-
|
|
363
207
|
# string - Base DN for looking up users in LDAP server
|
|
364
208
|
def ldap_base_dn
|
|
365
209
|
@attributes[:ldap_base_dn]
|
|
366
210
|
end
|
|
367
211
|
|
|
368
|
-
def ldap_base_dn=(value)
|
|
369
|
-
@attributes[:ldap_base_dn] = value
|
|
370
|
-
end
|
|
371
|
-
|
|
372
212
|
# string - Domain name that will be appended to LDAP usernames
|
|
373
213
|
def ldap_domain
|
|
374
214
|
@attributes[:ldap_domain]
|
|
375
215
|
end
|
|
376
216
|
|
|
377
|
-
def ldap_domain=(value)
|
|
378
|
-
@attributes[:ldap_domain] = value
|
|
379
|
-
end
|
|
380
|
-
|
|
381
217
|
# boolean - Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
382
218
|
def enabled
|
|
383
219
|
@attributes[:enabled]
|
|
384
220
|
end
|
|
385
221
|
|
|
386
|
-
def enabled=(value)
|
|
387
|
-
@attributes[:enabled] = value
|
|
388
|
-
end
|
|
389
|
-
|
|
390
222
|
# boolean - Should this strategy be displayed on the login page?
|
|
391
223
|
def display_on_login_page
|
|
392
224
|
@attributes[:display_on_login_page]
|
|
393
225
|
end
|
|
394
226
|
|
|
395
|
-
def display_on_login_page=(value)
|
|
396
|
-
@attributes[:display_on_login_page] = value
|
|
397
|
-
end
|
|
398
|
-
|
|
399
227
|
# string - LDAP host
|
|
400
228
|
def ldap_host
|
|
401
229
|
@attributes[:ldap_host]
|
|
402
230
|
end
|
|
403
231
|
|
|
404
|
-
def ldap_host=(value)
|
|
405
|
-
@attributes[:ldap_host] = value
|
|
406
|
-
end
|
|
407
|
-
|
|
408
232
|
# string - LDAP backup host
|
|
409
233
|
def ldap_host_2
|
|
410
234
|
@attributes[:ldap_host_2]
|
|
411
235
|
end
|
|
412
236
|
|
|
413
|
-
def ldap_host_2=(value)
|
|
414
|
-
@attributes[:ldap_host_2] = value
|
|
415
|
-
end
|
|
416
|
-
|
|
417
237
|
# string - LDAP backup host
|
|
418
238
|
def ldap_host_3
|
|
419
239
|
@attributes[:ldap_host_3]
|
|
420
240
|
end
|
|
421
241
|
|
|
422
|
-
def ldap_host_3=(value)
|
|
423
|
-
@attributes[:ldap_host_3] = value
|
|
424
|
-
end
|
|
425
|
-
|
|
426
242
|
# int64 - LDAP port
|
|
427
243
|
def ldap_port
|
|
428
244
|
@attributes[:ldap_port]
|
|
429
245
|
end
|
|
430
246
|
|
|
431
|
-
def ldap_port=(value)
|
|
432
|
-
@attributes[:ldap_port] = value
|
|
433
|
-
end
|
|
434
|
-
|
|
435
247
|
# boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
|
|
436
248
|
def ldap_provisioning_enabled
|
|
437
249
|
@attributes[:ldap_provisioning_enabled]
|
|
438
250
|
end
|
|
439
251
|
|
|
440
|
-
def ldap_provisioning_enabled=(value)
|
|
441
|
-
@attributes[:ldap_provisioning_enabled] = value
|
|
442
|
-
end
|
|
443
|
-
|
|
444
252
|
# boolean - Use secure LDAP?
|
|
445
253
|
def ldap_secure
|
|
446
254
|
@attributes[:ldap_secure]
|
|
447
255
|
end
|
|
448
256
|
|
|
449
|
-
def ldap_secure=(value)
|
|
450
|
-
@attributes[:ldap_secure] = value
|
|
451
|
-
end
|
|
452
|
-
|
|
453
257
|
# string - LDAP server type
|
|
454
258
|
def ldap_type
|
|
455
259
|
@attributes[:ldap_type]
|
|
456
260
|
end
|
|
457
261
|
|
|
458
|
-
def ldap_type=(value)
|
|
459
|
-
@attributes[:ldap_type] = value
|
|
460
|
-
end
|
|
461
|
-
|
|
462
262
|
# string - Username for signing in to LDAP server.
|
|
463
263
|
def ldap_username
|
|
464
264
|
@attributes[:ldap_username]
|
|
465
265
|
end
|
|
466
266
|
|
|
467
|
-
def ldap_username=(value)
|
|
468
|
-
@attributes[:ldap_username] = value
|
|
469
|
-
end
|
|
470
|
-
|
|
471
267
|
# string - LDAP username field
|
|
472
268
|
def ldap_username_field
|
|
473
269
|
@attributes[:ldap_username_field]
|
|
474
270
|
end
|
|
475
271
|
|
|
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
|
-
|
|
543
272
|
# Synchronize provisioning data with the SSO remote server
|
|
544
273
|
def sync(params = {})
|
|
545
274
|
params ||= {}
|
|
@@ -551,137 +280,6 @@ module Files
|
|
|
551
280
|
Api.send_request("/sso_strategies/#{@attributes[:id]}/sync", :post, params, @options)
|
|
552
281
|
end
|
|
553
282
|
|
|
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
|
-
|
|
685
283
|
# Parameters:
|
|
686
284
|
# 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.
|
|
687
285
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
@@ -716,107 +314,6 @@ module Files
|
|
|
716
314
|
find(id, params, options)
|
|
717
315
|
end
|
|
718
316
|
|
|
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
|
-
|
|
820
317
|
# Synchronize provisioning data with the SSO remote server
|
|
821
318
|
def self.sync(id, params = {}, options = {})
|
|
822
319
|
params ||= {}
|
|
@@ -827,134 +324,5 @@ module Files
|
|
|
827
324
|
Api.send_request("/sso_strategies/#{params[:id]}/sync", :post, params, options)
|
|
828
325
|
nil
|
|
829
326
|
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
|
|
959
327
|
end
|
|
960
328
|
end
|