Class: Files::SsoStrategy

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/sso_strategy.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ SsoStrategy

Returns a new instance of SsoStrategy.



7
8
9
10
 
# File 'lib/files.com/models/sso_strategy.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/sso_strategy.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/sso_strategy.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



699
700
701
 
# File 'lib/files.com/models/sso_strategy.rb', line 699

def self.all(params = {}, options = {})
  list(params, options)
end

.create(params = {}, options = {}) ⇒ Object

Parameters:

client_id - string - OAuth Client ID for your auth provider.
client_secret - string - OAuth Client Secret for your auth provider.
ldap_password - string - Password for signing in to LDAP server.
logo_delete - boolean - If true, the logo will be deleted.
logo_file - file - A logo to display on the login page.
reset_scim_oauth_access_token - boolean - If true, perform a reset on SCIM OAuth access token
scim_password - string - SCIM password applicable to basic authentication.
deprovision_behavior - string - Method used for deprovisioning users.
deprovision_groups - boolean - Auto-deprovision group membership based on group memberships on the SSO side?
deprovision_users - boolean - Auto-deprovision users?
display_on_login_page - boolean - Should this strategy be displayed on the login page?
enabled - boolean - Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
label - string - Custom label for the SSO provider on the login page.
ldap_base_dn - string - Base DN for looking up users in LDAP server
ldap_domain - string - Domain name that will be appended to LDAP usernames
ldap_host - string - LDAP host
ldap_host_2 - string - LDAP backup host
ldap_host_3 - string - LDAP backup host
ldap_port - int64 - LDAP port
ldap_provisioning_enabled - boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
ldap_secure - boolean - Use secure LDAP?
ldap_type - string - LDAP server type
ldap_username - string - Username for signing in to LDAP server.
ldap_username_field - string - LDAP username field
protocol - string - SSO Protocol
provider - string - Provider name
provider_identifier - string - URL-friendly, unique identifier for Azure SAML configuration
provision_company - string - Default company for auto provisioned users.
provision_dav_permission - boolean - Auto-provisioned users get WebDAV permission?
provision_email_signup_groups - string - Comma-separated list of group names whose members will be created with email_signup authentication.
provision_filesystem_layout - string - File System layout to use for auto provisioned users.
provision_ftp_permission - boolean - Auto-provisioned users get FTP permission?
provision_group_admin_groups - string - Comma-separated list of group names whose members will be provisioned as Group Admins.
provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
provision_groups - boolean - Auto-provision group membership based on group memberships on the SSO side?
provision_readonly_site_admin_groups - string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
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.
provision_sftp_permission - boolean - Auto-provisioned users get SFTP permission?
provision_site_admin_groups - string - Comma-separated list of group names whose members will be created as Site Admins.
provision_time_zone - string - Default time zone for auto provisioned users.
provision_users - boolean - Auto-provision users?
saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
saml_provider_issuer_url - string - Identity provider issuer url
saml_provider_metadata_content - string - Custom identity provider metadata
saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
saml_provider_slo_target_url - string - Identity provider SLO endpoint
saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
scim_authentication_method - string - SCIM authentication type.
scim_oauth_access_token_expires_at - string - SCIM OAuth Access Token Expiration Time.
scim_username - string - SCIM username.
subdomain - string - Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`

Raises:



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/files.com/models/sso_strategy.rb', line 774

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params[:client_id] and !params[:client_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params[:client_secret] and !params[:client_secret].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_password must be an String") if params[:ldap_password] and !params[:ldap_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params[:scim_password] and !params[:scim_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: deprovision_behavior must be an String") if params[:deprovision_behavior] and !params[:deprovision_behavior].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: label must be an String") if params[:label] and !params[:label].is_a?(String)
  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)
  raise InvalidParameterError.new("Bad parameter: ldap_domain must be an String") if params[:ldap_domain] and !params[:ldap_domain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_host must be an String") if params[:ldap_host] and !params[:ldap_host].is_a?(String)
  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)
  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)
  raise InvalidParameterError.new("Bad parameter: ldap_port must be an Integer") if params[:ldap_port] and !params[:ldap_port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: ldap_type must be an String") if params[:ldap_type] and !params[:ldap_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_username must be an String") if params[:ldap_username] and !params[:ldap_username].is_a?(String)
  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)
  raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params[:protocol] and !params[:protocol].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provider must be an String") if params[:provider] and !params[:provider].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provider_identifier must be an String") if params[:provider_identifier] and !params[:provider_identifier].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provision_company must be an String") if params[:provision_company] and !params[:provision_company].is_a?(String)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params[:scim_username] and !params[:scim_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)

  response, options = Api.send_request("/sso_strategies", :post, params, options)
  SsoStrategy.new(response.data, options)
end

.create_export(params = {}, options = {}) ⇒ Object

Parameters:

sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .

Raises:



833
834
835
836
837
838
 
# File 'lib/files.com/models/sso_strategy.rb', line 833

def self.create_export(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)

  response, options = Api.send_request("/sso_strategies/create_export", :post, params, options)
  Export.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



945
946
947
948
949
950
951
952
953
 
# File 'lib/files.com/models/sso_strategy.rb', line 945

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sso_strategies/#{params[:id]}", :delete, params, options)
  nil
end

.destroy(id, params = {}, options = {}) ⇒ Object 



955
956
957
958
 
# File 'lib/files.com/models/sso_strategy.rb', line 955

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
  nil
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Sso Strategy ID.

Raises:



705
706
707
708
709
710
711
712
713
 
# File 'lib/files.com/models/sso_strategy.rb', line 705

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/sso_strategies/#{params[:id]}", :get, params, options)
  SsoStrategy.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



715
716
717
 
# File 'lib/files.com/models/sso_strategy.rb', line 715

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

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.
per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .

Raises:



689
690
691
692
693
694
695
696
697
 
# File 'lib/files.com/models/sso_strategy.rb', line 689

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)

  List.new(SsoStrategy, params) do
    Api.send_request("/sso_strategies", :get, params, options)
  end
end

.sync(id, params = {}, options = {}) ⇒ Object

Synchronize provisioning data with the SSO remote server

Raises:



821
822
823
824
825
826
827
828
829
 
# File 'lib/files.com/models/sso_strategy.rb', line 821

def self.sync(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sso_strategies/#{params[:id]}/sync", :post, params, options)
  nil
end

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

client_id - string - OAuth Client ID for your auth provider.
client_secret - string - OAuth Client Secret for your auth provider.
ldap_password - string - Password for signing in to LDAP server.
logo_delete - boolean - If true, the logo will be deleted.
logo_file - file - A logo to display on the login page.
reset_scim_oauth_access_token - boolean - If true, perform a reset on SCIM OAuth access token
scim_password - string - SCIM password applicable to basic authentication.
deprovision_behavior - string - Method used for deprovisioning users.
deprovision_groups - boolean - Auto-deprovision group membership based on group memberships on the SSO side?
deprovision_users - boolean - Auto-deprovision users?
display_on_login_page - boolean - Should this strategy be displayed on the login page?
enabled - boolean - Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
label - string - Custom label for the SSO provider on the login page.
ldap_base_dn - string - Base DN for looking up users in LDAP server
ldap_domain - string - Domain name that will be appended to LDAP usernames
ldap_host - string - LDAP host
ldap_host_2 - string - LDAP backup host
ldap_host_3 - string - LDAP backup host
ldap_port - int64 - LDAP port
ldap_provisioning_enabled - boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
ldap_secure - boolean - Use secure LDAP?
ldap_type - string - LDAP server type
ldap_username - string - Username for signing in to LDAP server.
ldap_username_field - string - LDAP username field
protocol - string - SSO Protocol
provider - string - Provider name
provider_identifier - string - URL-friendly, unique identifier for Azure SAML configuration
provision_company - string - Default company for auto provisioned users.
provision_dav_permission - boolean - Auto-provisioned users get WebDAV permission?
provision_email_signup_groups - string - Comma-separated list of group names whose members will be created with email_signup authentication.
provision_filesystem_layout - string - File System layout to use for auto provisioned users.
provision_ftp_permission - boolean - Auto-provisioned users get FTP permission?
provision_group_admin_groups - string - Comma-separated list of group names whose members will be provisioned as Group Admins.
provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
provision_groups - boolean - Auto-provision group membership based on group memberships on the SSO side?
provision_readonly_site_admin_groups - string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
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.
provision_sftp_permission - boolean - Auto-provisioned users get SFTP permission?
provision_site_admin_groups - string - Comma-separated list of group names whose members will be created as Site Admins.
provision_time_zone - string - Default time zone for auto provisioned users.
provision_users - boolean - Auto-provision users?
saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
saml_provider_issuer_url - string - Identity provider issuer url
saml_provider_metadata_content - string - Custom identity provider metadata
saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
saml_provider_slo_target_url - string - Identity provider SLO endpoint
saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
scim_authentication_method - string - SCIM authentication type.
scim_oauth_access_token_expires_at - string - SCIM OAuth Access Token Expiration Time.
scim_username - string - SCIM username.
subdomain - string - Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`

Raises:



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/files.com/models/sso_strategy.rb', line 895

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params[:client_id] and !params[:client_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params[:client_secret] and !params[:client_secret].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_password must be an String") if params[:ldap_password] and !params[:ldap_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params[:scim_password] and !params[:scim_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: deprovision_behavior must be an String") if params[:deprovision_behavior] and !params[:deprovision_behavior].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: label must be an String") if params[:label] and !params[:label].is_a?(String)
  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)
  raise InvalidParameterError.new("Bad parameter: ldap_domain must be an String") if params[:ldap_domain] and !params[:ldap_domain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_host must be an String") if params[:ldap_host] and !params[:ldap_host].is_a?(String)
  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)
  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)
  raise InvalidParameterError.new("Bad parameter: ldap_port must be an Integer") if params[:ldap_port] and !params[:ldap_port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: ldap_type must be an String") if params[:ldap_type] and !params[:ldap_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_username must be an String") if params[:ldap_username] and !params[:ldap_username].is_a?(String)
  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)
  raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params[:protocol] and !params[:protocol].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provider must be an String") if params[:provider] and !params[:provider].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provider_identifier must be an String") if params[:provider_identifier] and !params[:provider_identifier].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provision_company must be an String") if params[:provision_company] and !params[:provision_company].is_a?(String)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params[:scim_username] and !params[:scim_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/sso_strategies/#{params[:id]}", :patch, params, options)
  SsoStrategy.new(response.data, options)
end

Instance Method Details

#client_id ⇒ Object

string - OAuth Client ID for your auth provider.



481
482
483
 
# File 'lib/files.com/models/sso_strategy.rb', line 481

def client_id
  @attributes[:client_id]
end

#client_id=(value) ⇒ Object 



485
486
487
 
# File 'lib/files.com/models/sso_strategy.rb', line 485

def client_id=(value)
  @attributes[:client_id] = value
end

#client_secret ⇒ Object

string - OAuth Client Secret for your auth provider.



490
491
492
 
# File 'lib/files.com/models/sso_strategy.rb', line 490

def client_secret
  @attributes[:client_secret]
end

#client_secret=(value) ⇒ Object 



494
495
496
 
# File 'lib/files.com/models/sso_strategy.rb', line 494

def client_secret=(value)
  @attributes[:client_secret] = value
end

#delete(params = {}) ⇒ Object

Raises:



659
660
661
662
663
664
665
666
667
 
# File 'lib/files.com/models/sso_strategy.rb', line 659

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sso_strategies/#{@attributes[:id]}", :delete, params, @options)
end

#deprovision_behavior ⇒ Object

string - Method used for deprovisioning users.



202
203
204
 
# File 'lib/files.com/models/sso_strategy.rb', line 202

def deprovision_behavior
  @attributes[:deprovision_behavior]
end

#deprovision_behavior=(value) ⇒ Object 



206
207
208
 
# File 'lib/files.com/models/sso_strategy.rb', line 206

def deprovision_behavior=(value)
  @attributes[:deprovision_behavior] = value
end

#deprovision_groups ⇒ Object

boolean - Auto-deprovision group membership based on group memberships on the SSO side?



193
194
195
 
# File 'lib/files.com/models/sso_strategy.rb', line 193

def deprovision_groups
  @attributes[:deprovision_groups]
end

#deprovision_groups=(value) ⇒ Object 



197
198
199
 
# File 'lib/files.com/models/sso_strategy.rb', line 197

def deprovision_groups=(value)
  @attributes[:deprovision_groups] = value
end

#deprovision_users ⇒ Object

boolean - Auto-deprovision users?



184
185
186
 
# File 'lib/files.com/models/sso_strategy.rb', line 184

def deprovision_users
  @attributes[:deprovision_users]
end

#deprovision_users=(value) ⇒ Object 



188
189
190
 
# File 'lib/files.com/models/sso_strategy.rb', line 188

def deprovision_users=(value)
  @attributes[:deprovision_users] = value
end

#destroy(params = {}) ⇒ Object 



669
670
671
672
 
# File 'lib/files.com/models/sso_strategy.rb', line 669

def destroy(params = {})
  delete(params)
  nil
end

#display_on_login_page ⇒ Object

boolean - Should this strategy be displayed on the login page?



391
392
393
 
# File 'lib/files.com/models/sso_strategy.rb', line 391

def 
  @attributes[:display_on_login_page]
end

#display_on_login_page=(value) ⇒ Object 



395
396
397
 
# File 'lib/files.com/models/sso_strategy.rb', line 395

def (value)
  @attributes[:display_on_login_page] = value
end

#enabled ⇒ Object

boolean - Is strategy enabled? This may become automatically set to false after a high number and duration of failures.



382
383
384
 
# File 'lib/files.com/models/sso_strategy.rb', line 382

def enabled
  @attributes[:enabled]
end

#enabled=(value) ⇒ Object 



386
387
388
 
# File 'lib/files.com/models/sso_strategy.rb', line 386

def enabled=(value)
  @attributes[:enabled] = value
end

#id ⇒ Object

int64 - ID



49
50
51
 
# File 'lib/files.com/models/sso_strategy.rb', line 49

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/sso_strategy.rb', line 53

def id=(value)
  @attributes[:id] = value
end

#label ⇒ Object

string - Custom label for the SSO provider on the login page.



31
32
33
 
# File 'lib/files.com/models/sso_strategy.rb', line 31

def label
  @attributes[:label]
end

#label=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/sso_strategy.rb', line 35

def label=(value)
  @attributes[:label] = value
end

#ldap_base_dn ⇒ Object

string - Base DN for looking up users in LDAP server



364
365
366
 
# File 'lib/files.com/models/sso_strategy.rb', line 364

def ldap_base_dn
  @attributes[:ldap_base_dn]
end

#ldap_base_dn=(value) ⇒ Object 



368
369
370
 
# File 'lib/files.com/models/sso_strategy.rb', line 368

def ldap_base_dn=(value)
  @attributes[:ldap_base_dn] = value
end

#ldap_domain ⇒ Object

string - Domain name that will be appended to LDAP usernames



373
374
375
 
# File 'lib/files.com/models/sso_strategy.rb', line 373

def ldap_domain
  @attributes[:ldap_domain]
end

#ldap_domain=(value) ⇒ Object 



377
378
379
 
# File 'lib/files.com/models/sso_strategy.rb', line 377

def ldap_domain=(value)
  @attributes[:ldap_domain] = value
end

#ldap_host ⇒ Object

string - LDAP host



400
401
402
 
# File 'lib/files.com/models/sso_strategy.rb', line 400

def ldap_host
  @attributes[:ldap_host]
end

#ldap_host=(value) ⇒ Object 



404
405
406
 
# File 'lib/files.com/models/sso_strategy.rb', line 404

def ldap_host=(value)
  @attributes[:ldap_host] = value
end

#ldap_host_2 ⇒ Object

string - LDAP backup host



409
410
411
 
# File 'lib/files.com/models/sso_strategy.rb', line 409

def ldap_host_2
  @attributes[:ldap_host_2]
end

#ldap_host_2=(value) ⇒ Object 



413
414
415
 
# File 'lib/files.com/models/sso_strategy.rb', line 413

def ldap_host_2=(value)
  @attributes[:ldap_host_2] = value
end

#ldap_host_3 ⇒ Object

string - LDAP backup host



418
419
420
 
# File 'lib/files.com/models/sso_strategy.rb', line 418

def ldap_host_3
  @attributes[:ldap_host_3]
end

#ldap_host_3=(value) ⇒ Object 



422
423
424
 
# File 'lib/files.com/models/sso_strategy.rb', line 422

def ldap_host_3=(value)
  @attributes[:ldap_host_3] = value
end

#ldap_password ⇒ Object

string - Password for signing in to LDAP server.



499
500
501
 
# File 'lib/files.com/models/sso_strategy.rb', line 499

def ldap_password
  @attributes[:ldap_password]
end

#ldap_password=(value) ⇒ Object 



503
504
505
 
# File 'lib/files.com/models/sso_strategy.rb', line 503

def ldap_password=(value)
  @attributes[:ldap_password] = value
end

#ldap_port ⇒ Object

int64 - LDAP port



427
428
429
 
# File 'lib/files.com/models/sso_strategy.rb', line 427

def ldap_port
  @attributes[:ldap_port]
end

#ldap_port=(value) ⇒ Object 



431
432
433
 
# File 'lib/files.com/models/sso_strategy.rb', line 431

def ldap_port=(value)
  @attributes[:ldap_port] = value
end

#ldap_provisioning_enabled ⇒ Object

boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?



436
437
438
 
# File 'lib/files.com/models/sso_strategy.rb', line 436

def ldap_provisioning_enabled
  @attributes[:ldap_provisioning_enabled]
end

#ldap_provisioning_enabled=(value) ⇒ Object 



440
441
442
 
# File 'lib/files.com/models/sso_strategy.rb', line 440

def ldap_provisioning_enabled=(value)
  @attributes[:ldap_provisioning_enabled] = value
end

#ldap_secure ⇒ Object

boolean - Use secure LDAP?



445
446
447
 
# File 'lib/files.com/models/sso_strategy.rb', line 445

def ldap_secure
  @attributes[:ldap_secure]
end

#ldap_secure=(value) ⇒ Object 



449
450
451
 
# File 'lib/files.com/models/sso_strategy.rb', line 449

def ldap_secure=(value)
  @attributes[:ldap_secure] = value
end

#ldap_type ⇒ Object

string - LDAP server type



454
455
456
 
# File 'lib/files.com/models/sso_strategy.rb', line 454

def ldap_type
  @attributes[:ldap_type]
end

#ldap_type=(value) ⇒ Object 



458
459
460
 
# File 'lib/files.com/models/sso_strategy.rb', line 458

def ldap_type=(value)
  @attributes[:ldap_type] = value
end

#ldap_username ⇒ Object

string - Username for signing in to LDAP server.



463
464
465
 
# File 'lib/files.com/models/sso_strategy.rb', line 463

def ldap_username
  @attributes[:ldap_username]
end

#ldap_username=(value) ⇒ Object 



467
468
469
 
# File 'lib/files.com/models/sso_strategy.rb', line 467

def ldap_username=(value)
  @attributes[:ldap_username] = value
end

#ldap_username_field ⇒ Object

string - LDAP username field



472
473
474
 
# File 'lib/files.com/models/sso_strategy.rb', line 472

def ldap_username_field
  @attributes[:ldap_username_field]
end

#ldap_username_field=(value) ⇒ Object 



476
477
478
 
# File 'lib/files.com/models/sso_strategy.rb', line 476

def ldap_username_field=(value)
  @attributes[:ldap_username_field] = value
end

#logo_delete ⇒ Object

boolean - If true, the logo will be deleted.



508
509
510
 
# File 'lib/files.com/models/sso_strategy.rb', line 508

def logo_delete
  @attributes[:logo_delete]
end

#logo_delete=(value) ⇒ Object 



512
513
514
 
# File 'lib/files.com/models/sso_strategy.rb', line 512

def logo_delete=(value)
  @attributes[:logo_delete] = value
end

#logo_file ⇒ Object

file - A logo to display on the login page.



517
518
519
 
# File 'lib/files.com/models/sso_strategy.rb', line 517

def logo_file
  @attributes[:logo_file]
end

#logo_file=(value) ⇒ Object 



521
522
523
 
# File 'lib/files.com/models/sso_strategy.rb', line 521

def logo_file=(value)
  @attributes[:logo_file] = value
end

#logo_url ⇒ Object

string - URL holding a custom logo for the SSO provider on the login page.



40
41
42
 
# File 'lib/files.com/models/sso_strategy.rb', line 40

def logo_url
  @attributes[:logo_url]
end

#logo_url=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/sso_strategy.rb', line 44

def logo_url=(value)
  @attributes[:logo_url] = value
end

#protocol ⇒ Object

string - SSO Protocol



13
14
15
 
# File 'lib/files.com/models/sso_strategy.rb', line 13

def protocol
  @attributes[:protocol]
end

#protocol=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/sso_strategy.rb', line 17

def protocol=(value)
  @attributes[:protocol] = value
end

#provider ⇒ Object

string - Provider name



22
23
24
 
# File 'lib/files.com/models/sso_strategy.rb', line 22

def provider
  @attributes[:provider]
end

#provider=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/sso_strategy.rb', line 26

def provider=(value)
  @attributes[:provider] = value
end

#provider_identifier ⇒ Object

string - URL-friendly, unique identifier for Azure SAML configuration



355
356
357
 
# File 'lib/files.com/models/sso_strategy.rb', line 355

def provider_identifier
  @attributes[:provider_identifier]
end

#provider_identifier=(value) ⇒ Object 



359
360
361
 
# File 'lib/files.com/models/sso_strategy.rb', line 359

def provider_identifier=(value)
  @attributes[:provider_identifier] = value
end

#provision_attachments_permission ⇒ Object

boolean



283
284
285
 
# File 'lib/files.com/models/sso_strategy.rb', line 283

def provision_attachments_permission
  @attributes[:provision_attachments_permission]
end

#provision_attachments_permission=(value) ⇒ Object 



287
288
289
 
# File 'lib/files.com/models/sso_strategy.rb', line 287

def provision_attachments_permission=(value)
  @attributes[:provision_attachments_permission] = value
end

#provision_company ⇒ Object

string - Default company for auto provisioned users.



328
329
330
 
# File 'lib/files.com/models/sso_strategy.rb', line 328

def provision_company
  @attributes[:provision_company]
end

#provision_company=(value) ⇒ Object 



332
333
334
 
# File 'lib/files.com/models/sso_strategy.rb', line 332

def provision_company=(value)
  @attributes[:provision_company] = value
end

#provision_dav_permission ⇒ Object

boolean - Auto-provisioned users get WebDAV permission?



292
293
294
 
# File 'lib/files.com/models/sso_strategy.rb', line 292

def provision_dav_permission
  @attributes[:provision_dav_permission]
end

#provision_dav_permission=(value) ⇒ Object 



296
297
298
 
# File 'lib/files.com/models/sso_strategy.rb', line 296

def provision_dav_permission=(value)
  @attributes[:provision_dav_permission] = value
end

#provision_email_signup_groups ⇒ Object

string - Comma-separated list of group names whose members will be created with email_signup authentication.



247
248
249
 
# File 'lib/files.com/models/sso_strategy.rb', line 247

def 
  @attributes[:provision_email_signup_groups]
end

#provision_email_signup_groups=(value) ⇒ Object 



251
252
253
 
# File 'lib/files.com/models/sso_strategy.rb', line 251

def (value)
  @attributes[:provision_email_signup_groups] = value
end

#provision_filesystem_layout ⇒ Object

string - File System layout to use for auto provisioned users.



346
347
348
 
# File 'lib/files.com/models/sso_strategy.rb', line 346

def provision_filesystem_layout
  @attributes[:provision_filesystem_layout]
end

#provision_filesystem_layout=(value) ⇒ Object 



350
351
352
 
# File 'lib/files.com/models/sso_strategy.rb', line 350

def provision_filesystem_layout=(value)
  @attributes[:provision_filesystem_layout] = value
end

#provision_ftp_permission ⇒ Object

boolean - Auto-provisioned users get FTP permission?



301
302
303
 
# File 'lib/files.com/models/sso_strategy.rb', line 301

def provision_ftp_permission
  @attributes[:provision_ftp_permission]
end

#provision_ftp_permission=(value) ⇒ Object 



305
306
307
 
# File 'lib/files.com/models/sso_strategy.rb', line 305

def provision_ftp_permission=(value)
  @attributes[:provision_ftp_permission] = value
end

#provision_group_admin_groups ⇒ Object

string - Comma-separated list of group names whose members will be provisioned as Group Admins.



274
275
276
 
# File 'lib/files.com/models/sso_strategy.rb', line 274

def provision_group_admin_groups
  @attributes[:provision_group_admin_groups]
end

#provision_group_admin_groups=(value) ⇒ Object 



278
279
280
 
# File 'lib/files.com/models/sso_strategy.rb', line 278

def provision_group_admin_groups=(value)
  @attributes[:provision_group_admin_groups] = value
end

#provision_group_default ⇒ Object

string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.



211
212
213
 
# File 'lib/files.com/models/sso_strategy.rb', line 211

def provision_group_default
  @attributes[:provision_group_default]
end

#provision_group_default=(value) ⇒ Object 



215
216
217
 
# File 'lib/files.com/models/sso_strategy.rb', line 215

def provision_group_default=(value)
  @attributes[:provision_group_default] = value
end

#provision_group_exclusion ⇒ Object

string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.



220
221
222
 
# File 'lib/files.com/models/sso_strategy.rb', line 220

def provision_group_exclusion
  @attributes[:provision_group_exclusion]
end

#provision_group_exclusion=(value) ⇒ Object 



224
225
226
 
# File 'lib/files.com/models/sso_strategy.rb', line 224

def provision_group_exclusion=(value)
  @attributes[:provision_group_exclusion] = value
end

#provision_group_inclusion ⇒ Object

string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.



229
230
231
 
# File 'lib/files.com/models/sso_strategy.rb', line 229

def provision_group_inclusion
  @attributes[:provision_group_inclusion]
end

#provision_group_inclusion=(value) ⇒ Object 



233
234
235
 
# File 'lib/files.com/models/sso_strategy.rb', line 233

def provision_group_inclusion=(value)
  @attributes[:provision_group_inclusion] = value
end

#provision_group_required ⇒ Object

string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.



238
239
240
 
# File 'lib/files.com/models/sso_strategy.rb', line 238

def provision_group_required
  @attributes[:provision_group_required]
end

#provision_group_required=(value) ⇒ Object 



242
243
244
 
# File 'lib/files.com/models/sso_strategy.rb', line 242

def provision_group_required=(value)
  @attributes[:provision_group_required] = value
end

#provision_groups ⇒ Object

boolean - Auto-provision group membership based on group memberships on the SSO side?



175
176
177
 
# File 'lib/files.com/models/sso_strategy.rb', line 175

def provision_groups
  @attributes[:provision_groups]
end

#provision_groups=(value) ⇒ Object 



179
180
181
 
# File 'lib/files.com/models/sso_strategy.rb', line 179

def provision_groups=(value)
  @attributes[:provision_groups] = value
end

#provision_readonly_site_admin_groups ⇒ Object

string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.



256
257
258
 
# File 'lib/files.com/models/sso_strategy.rb', line 256

def provision_readonly_site_admin_groups
  @attributes[:provision_readonly_site_admin_groups]
end

#provision_readonly_site_admin_groups=(value) ⇒ Object 



260
261
262
 
# File 'lib/files.com/models/sso_strategy.rb', line 260

def provision_readonly_site_admin_groups=(value)
  @attributes[:provision_readonly_site_admin_groups] = value
end

#provision_require_2fa ⇒ Object

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
338
339
 
# File 'lib/files.com/models/sso_strategy.rb', line 337

def provision_require_2fa
  @attributes[:provision_require_2fa]
end

#provision_require_2fa=(value) ⇒ Object 



341
342
343
 
# File 'lib/files.com/models/sso_strategy.rb', line 341

def provision_require_2fa=(value)
  @attributes[:provision_require_2fa] = value
end

#provision_sftp_permission ⇒ Object

boolean - Auto-provisioned users get SFTP permission?



310
311
312
 
# File 'lib/files.com/models/sso_strategy.rb', line 310

def provision_sftp_permission
  @attributes[:provision_sftp_permission]
end

#provision_sftp_permission=(value) ⇒ Object 



314
315
316
 
# File 'lib/files.com/models/sso_strategy.rb', line 314

def provision_sftp_permission=(value)
  @attributes[:provision_sftp_permission] = value
end

#provision_site_admin_groups ⇒ Object

string - Comma-separated list of group names whose members will be created as Site Admins.



265
266
267
 
# File 'lib/files.com/models/sso_strategy.rb', line 265

def provision_site_admin_groups
  @attributes[:provision_site_admin_groups]
end

#provision_site_admin_groups=(value) ⇒ Object 



269
270
271
 
# File 'lib/files.com/models/sso_strategy.rb', line 269

def provision_site_admin_groups=(value)
  @attributes[:provision_site_admin_groups] = value
end

#provision_time_zone ⇒ Object

string - Default time zone for auto provisioned users.



319
320
321
 
# File 'lib/files.com/models/sso_strategy.rb', line 319

def provision_time_zone
  @attributes[:provision_time_zone]
end

#provision_time_zone=(value) ⇒ Object 



323
324
325
 
# File 'lib/files.com/models/sso_strategy.rb', line 323

def provision_time_zone=(value)
  @attributes[:provision_time_zone] = value
end

#provision_users ⇒ Object

boolean - Auto-provision users?



166
167
168
 
# File 'lib/files.com/models/sso_strategy.rb', line 166

def provision_users
  @attributes[:provision_users]
end

#provision_users=(value) ⇒ Object 



170
171
172
 
# File 'lib/files.com/models/sso_strategy.rb', line 170

def provision_users=(value)
  @attributes[:provision_users] = value
end

#reset_scim_oauth_access_token ⇒ Object

boolean - If true, perform a reset on SCIM OAuth access token



526
527
528
 
# File 'lib/files.com/models/sso_strategy.rb', line 526

def reset_scim_oauth_access_token
  @attributes[:reset_scim_oauth_access_token]
end

#reset_scim_oauth_access_token=(value) ⇒ Object 



530
531
532
 
# File 'lib/files.com/models/sso_strategy.rb', line 530

def reset_scim_oauth_access_token=(value)
  @attributes[:reset_scim_oauth_access_token] = value
end

#saml_provider_cert_fingerprint ⇒ Object

string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.



67
68
69
 
# File 'lib/files.com/models/sso_strategy.rb', line 67

def saml_provider_cert_fingerprint
  @attributes[:saml_provider_cert_fingerprint]
end

#saml_provider_cert_fingerprint=(value) ⇒ Object 



71
72
73
 
# File 'lib/files.com/models/sso_strategy.rb', line 71

def saml_provider_cert_fingerprint=(value)
  @attributes[:saml_provider_cert_fingerprint] = value
end

#saml_provider_issuer_url ⇒ Object

string - Identity provider issuer url



76
77
78
 
# File 'lib/files.com/models/sso_strategy.rb', line 76

def saml_provider_issuer_url
  @attributes[:saml_provider_issuer_url]
end

#saml_provider_issuer_url=(value) ⇒ Object 



80
81
82
 
# File 'lib/files.com/models/sso_strategy.rb', line 80

def saml_provider_issuer_url=(value)
  @attributes[:saml_provider_issuer_url] = value
end

#saml_provider_metadata_content ⇒ Object

string - Custom identity provider metadata



85
86
87
 
# File 'lib/files.com/models/sso_strategy.rb', line 85

def saml_provider_metadata_content
  @attributes[:saml_provider_metadata_content]
end

#saml_provider_metadata_content=(value) ⇒ Object 



89
90
91
 
# File 'lib/files.com/models/sso_strategy.rb', line 89

def saml_provider_metadata_content=(value)
  @attributes[:saml_provider_metadata_content] = value
end

#saml_provider_metadata_url ⇒ Object

string - Metadata URL for the SAML identity provider



94
95
96
 
# File 'lib/files.com/models/sso_strategy.rb', line 94

def saml_provider_metadata_url
  @attributes[:saml_provider_metadata_url]
end

#saml_provider_metadata_url=(value) ⇒ Object 



98
99
100
 
# File 'lib/files.com/models/sso_strategy.rb', line 98

def saml_provider_metadata_url=(value)
  @attributes[:saml_provider_metadata_url] = value
end

#saml_provider_slo_target_url ⇒ Object

string - Identity provider SLO endpoint



103
104
105
 
# File 'lib/files.com/models/sso_strategy.rb', line 103

def saml_provider_slo_target_url
  @attributes[:saml_provider_slo_target_url]
end

#saml_provider_slo_target_url=(value) ⇒ Object 



107
108
109
 
# File 'lib/files.com/models/sso_strategy.rb', line 107

def saml_provider_slo_target_url=(value)
  @attributes[:saml_provider_slo_target_url] = value
end

#saml_provider_sso_target_url ⇒ Object

string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.



112
113
114
 
# File 'lib/files.com/models/sso_strategy.rb', line 112

def saml_provider_sso_target_url
  @attributes[:saml_provider_sso_target_url]
end

#saml_provider_sso_target_url=(value) ⇒ Object 



116
117
118
 
# File 'lib/files.com/models/sso_strategy.rb', line 116

def saml_provider_sso_target_url=(value)
  @attributes[:saml_provider_sso_target_url] = value
end

#save ⇒ Object 



674
675
676
677
678
679
680
681
682
683
 
# File 'lib/files.com/models/sso_strategy.rb', line 674

def save
  if @attributes[:id]
    new_obj = update(@attributes)
  else
    new_obj = SsoStrategy.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#scim_authentication_method ⇒ Object

string - SCIM authentication type.



121
122
123
 
# File 'lib/files.com/models/sso_strategy.rb', line 121

def scim_authentication_method
  @attributes[:scim_authentication_method]
end

#scim_authentication_method=(value) ⇒ Object 



125
126
127
 
# File 'lib/files.com/models/sso_strategy.rb', line 125

def scim_authentication_method=(value)
  @attributes[:scim_authentication_method] = value
end

#scim_oauth_access_token ⇒ Object

string - SCIM OAuth Access Token.



139
140
141
 
# File 'lib/files.com/models/sso_strategy.rb', line 139

def scim_oauth_access_token
  @attributes[:scim_oauth_access_token]
end

#scim_oauth_access_token=(value) ⇒ Object 



143
144
145
 
# File 'lib/files.com/models/sso_strategy.rb', line 143

def scim_oauth_access_token=(value)
  @attributes[:scim_oauth_access_token] = value
end

#scim_oauth_access_token_expires_at ⇒ Object

string - SCIM OAuth Access Token Expiration Time.



148
149
150
 
# File 'lib/files.com/models/sso_strategy.rb', line 148

def scim_oauth_access_token_expires_at
  @attributes[:scim_oauth_access_token_expires_at]
end

#scim_oauth_access_token_expires_at=(value) ⇒ Object 



152
153
154
 
# File 'lib/files.com/models/sso_strategy.rb', line 152

def scim_oauth_access_token_expires_at=(value)
  @attributes[:scim_oauth_access_token_expires_at] = value
end

#scim_password ⇒ Object

string - SCIM password applicable to basic authentication.



535
536
537
 
# File 'lib/files.com/models/sso_strategy.rb', line 535

def scim_password
  @attributes[:scim_password]
end

#scim_password=(value) ⇒ Object 



539
540
541
 
# File 'lib/files.com/models/sso_strategy.rb', line 539

def scim_password=(value)
  @attributes[:scim_password] = value
end

#scim_username ⇒ Object

string - SCIM username.



130
131
132
 
# File 'lib/files.com/models/sso_strategy.rb', line 130

def scim_username
  @attributes[:scim_username]
end

#scim_username=(value) ⇒ Object 



134
135
136
 
# File 'lib/files.com/models/sso_strategy.rb', line 134

def scim_username=(value)
  @attributes[:scim_username] = value
end

#subdomain ⇒ Object

string - Subdomain or domain name for your auth provider. Example: https://[subdomain].okta.com/



157
158
159
 
# File 'lib/files.com/models/sso_strategy.rb', line 157

def subdomain
  @attributes[:subdomain]
end

#subdomain=(value) ⇒ Object 



161
162
163
 
# File 'lib/files.com/models/sso_strategy.rb', line 161

def subdomain=(value)
  @attributes[:subdomain] = value
end

#sync(params = {}) ⇒ Object

Synchronize provisioning data with the SSO remote server

Raises:



544
545
546
547
548
549
550
551
552
 
# File 'lib/files.com/models/sso_strategy.rb', line 544

def sync(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sso_strategies/#{@attributes[:id]}/sync", :post, params, @options)
end

#update(params = {}) ⇒ Object

Parameters:

client_id - string - OAuth Client ID for your auth provider.
client_secret - string - OAuth Client Secret for your auth provider.
ldap_password - string - Password for signing in to LDAP server.
logo_delete - boolean - If true, the logo will be deleted.
logo_file - file - A logo to display on the login page.
reset_scim_oauth_access_token - boolean - If true, perform a reset on SCIM OAuth access token
scim_password - string - SCIM password applicable to basic authentication.
deprovision_behavior - string - Method used for deprovisioning users.
deprovision_groups - boolean - Auto-deprovision group membership based on group memberships on the SSO side?
deprovision_users - boolean - Auto-deprovision users?
display_on_login_page - boolean - Should this strategy be displayed on the login page?
enabled - boolean - Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
label - string - Custom label for the SSO provider on the login page.
ldap_base_dn - string - Base DN for looking up users in LDAP server
ldap_domain - string - Domain name that will be appended to LDAP usernames
ldap_host - string - LDAP host
ldap_host_2 - string - LDAP backup host
ldap_host_3 - string - LDAP backup host
ldap_port - int64 - LDAP port
ldap_provisioning_enabled - boolean - Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
ldap_secure - boolean - Use secure LDAP?
ldap_type - string - LDAP server type
ldap_username - string - Username for signing in to LDAP server.
ldap_username_field - string - LDAP username field
protocol - string - SSO Protocol
provider - string - Provider name
provider_identifier - string - URL-friendly, unique identifier for Azure SAML configuration
provision_company - string - Default company for auto provisioned users.
provision_dav_permission - boolean - Auto-provisioned users get WebDAV permission?
provision_email_signup_groups - string - Comma-separated list of group names whose members will be created with email_signup authentication.
provision_filesystem_layout - string - File System layout to use for auto provisioned users.
provision_ftp_permission - boolean - Auto-provisioned users get FTP permission?
provision_group_admin_groups - string - Comma-separated list of group names whose members will be provisioned as Group Admins.
provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
provision_groups - boolean - Auto-provision group membership based on group memberships on the SSO side?
provision_readonly_site_admin_groups - string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
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.
provision_sftp_permission - boolean - Auto-provisioned users get SFTP permission?
provision_site_admin_groups - string - Comma-separated list of group names whose members will be created as Site Admins.
provision_time_zone - string - Default time zone for auto provisioned users.
provision_users - boolean - Auto-provision users?
saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
saml_provider_issuer_url - string - Identity provider issuer url
saml_provider_metadata_content - string - Custom identity provider metadata
saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
saml_provider_slo_target_url - string - Identity provider SLO endpoint
saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
scim_authentication_method - string - SCIM authentication type.
scim_oauth_access_token_expires_at - string - SCIM OAuth Access Token Expiration Time.
scim_username - string - SCIM username.
subdomain - string - Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`

Raises:



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/files.com/models/sso_strategy.rb', line 609

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params[:client_id] and !params[:client_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params[:client_secret] and !params[:client_secret].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_password must be an String") if params[:ldap_password] and !params[:ldap_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params[:scim_password] and !params[:scim_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: deprovision_behavior must be an String") if params[:deprovision_behavior] and !params[:deprovision_behavior].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: label must be an String") if params[:label] and !params[:label].is_a?(String)
  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)
  raise InvalidParameterError.new("Bad parameter: ldap_domain must be an String") if params[:ldap_domain] and !params[:ldap_domain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_host must be an String") if params[:ldap_host] and !params[:ldap_host].is_a?(String)
  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)
  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)
  raise InvalidParameterError.new("Bad parameter: ldap_port must be an Integer") if params[:ldap_port] and !params[:ldap_port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: ldap_type must be an String") if params[:ldap_type] and !params[:ldap_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_username must be an String") if params[:ldap_username] and !params[:ldap_username].is_a?(String)
  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)
  raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params[:protocol] and !params[:protocol].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provider must be an String") if params[:provider] and !params[:provider].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provider_identifier must be an String") if params[:provider_identifier] and !params[:provider_identifier].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: provision_company must be an String") if params[:provision_company] and !params[:provision_company].is_a?(String)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  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)
  raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params[:scim_username] and !params[:scim_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sso_strategies/#{@attributes[:id]}", :patch, params, @options)
end

#user_count ⇒ Object

int64 - Count of users with this SSO Strategy



58
59
60
 
# File 'lib/files.com/models/sso_strategy.rb', line 58

def user_count
  @attributes[:user_count]
end

#user_count=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/sso_strategy.rb', line 62

def user_count=(value)
  @attributes[:user_count] = value
end