Class: OCI::IdentityDomains::Models::AuthenticationFactorSetting

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/authentication_factor_setting.rb

Overview

Multi Factor Authentication Settings for Tenant

Constant Summary collapse

IDCS_PREVENTED_OPERATIONS_ENUM = 
[
  IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'.freeze,
  IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'.freeze,
  IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'.freeze,
  IDCS_PREVENTED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
USER_ENROLLMENT_DISABLED_FACTORS_ENUM = 
[
  USER_ENROLLMENT_DISABLED_FACTORS_EMAIL = 'EMAIL'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_SMS = 'SMS'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_TOTP = 'TOTP'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_PUSH = 'PUSH'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_OFFLINETOTP = 'OFFLINETOTP'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_VOICE = 'VOICE'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_PHONE_CALL = 'PHONE_CALL'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_THIRDPARTY = 'THIRDPARTY'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_FIDO_AUTHENTICATOR = 'FIDO_AUTHENTICATOR'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_YUBICO_OTP = 'YUBICO_OTP'.freeze,
  USER_ENROLLMENT_DISABLED_FACTORS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticationFactorSetting

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
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
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 568

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.ocid = attributes[:'ocid'] if attributes[:'ocid']

  self.schemas = attributes[:'schemas'] if attributes[:'schemas']

  self.meta = attributes[:'meta'] if attributes[:'meta']

  self.idcs_created_by = attributes[:'idcsCreatedBy'] if attributes[:'idcsCreatedBy']

  raise 'You cannot provide both :idcsCreatedBy and :idcs_created_by' if attributes.key?(:'idcsCreatedBy') && attributes.key?(:'idcs_created_by')

  self.idcs_created_by = attributes[:'idcs_created_by'] if attributes[:'idcs_created_by']

  self.idcs_last_modified_by = attributes[:'idcsLastModifiedBy'] if attributes[:'idcsLastModifiedBy']

  raise 'You cannot provide both :idcsLastModifiedBy and :idcs_last_modified_by' if attributes.key?(:'idcsLastModifiedBy') && attributes.key?(:'idcs_last_modified_by')

  self.idcs_last_modified_by = attributes[:'idcs_last_modified_by'] if attributes[:'idcs_last_modified_by']

  self.idcs_prevented_operations = attributes[:'idcsPreventedOperations'] if attributes[:'idcsPreventedOperations']

  raise 'You cannot provide both :idcsPreventedOperations and :idcs_prevented_operations' if attributes.key?(:'idcsPreventedOperations') && attributes.key?(:'idcs_prevented_operations')

  self.idcs_prevented_operations = attributes[:'idcs_prevented_operations'] if attributes[:'idcs_prevented_operations']

  self.tags = attributes[:'tags'] if attributes[:'tags']

  self.delete_in_progress = attributes[:'deleteInProgress'] unless attributes[:'deleteInProgress'].nil?

  raise 'You cannot provide both :deleteInProgress and :delete_in_progress' if attributes.key?(:'deleteInProgress') && attributes.key?(:'delete_in_progress')

  self.delete_in_progress = attributes[:'delete_in_progress'] unless attributes[:'delete_in_progress'].nil?

  self.idcs_last_upgraded_in_release = attributes[:'idcsLastUpgradedInRelease'] if attributes[:'idcsLastUpgradedInRelease']

  raise 'You cannot provide both :idcsLastUpgradedInRelease and :idcs_last_upgraded_in_release' if attributes.key?(:'idcsLastUpgradedInRelease') && attributes.key?(:'idcs_last_upgraded_in_release')

  self.idcs_last_upgraded_in_release = attributes[:'idcs_last_upgraded_in_release'] if attributes[:'idcs_last_upgraded_in_release']

  self.domain_ocid = attributes[:'domainOcid'] if attributes[:'domainOcid']

  raise 'You cannot provide both :domainOcid and :domain_ocid' if attributes.key?(:'domainOcid') && attributes.key?(:'domain_ocid')

  self.domain_ocid = attributes[:'domain_ocid'] if attributes[:'domain_ocid']

  self.compartment_ocid = attributes[:'compartmentOcid'] if attributes[:'compartmentOcid']

  raise 'You cannot provide both :compartmentOcid and :compartment_ocid' if attributes.key?(:'compartmentOcid') && attributes.key?(:'compartment_ocid')

  self.compartment_ocid = attributes[:'compartment_ocid'] if attributes[:'compartment_ocid']

  self.tenancy_ocid = attributes[:'tenancyOcid'] if attributes[:'tenancyOcid']

  raise 'You cannot provide both :tenancyOcid and :tenancy_ocid' if attributes.key?(:'tenancyOcid') && attributes.key?(:'tenancy_ocid')

  self.tenancy_ocid = attributes[:'tenancy_ocid'] if attributes[:'tenancy_ocid']

  self.email_enabled = attributes[:'emailEnabled'] unless attributes[:'emailEnabled'].nil?

  raise 'You cannot provide both :emailEnabled and :email_enabled' if attributes.key?(:'emailEnabled') && attributes.key?(:'email_enabled')

  self.email_enabled = attributes[:'email_enabled'] unless attributes[:'email_enabled'].nil?

  self.sms_enabled = attributes[:'smsEnabled'] unless attributes[:'smsEnabled'].nil?

  raise 'You cannot provide both :smsEnabled and :sms_enabled' if attributes.key?(:'smsEnabled') && attributes.key?(:'sms_enabled')

  self.sms_enabled = attributes[:'sms_enabled'] unless attributes[:'sms_enabled'].nil?

  self.phone_call_enabled = attributes[:'phoneCallEnabled'] unless attributes[:'phoneCallEnabled'].nil?

  raise 'You cannot provide both :phoneCallEnabled and :phone_call_enabled' if attributes.key?(:'phoneCallEnabled') && attributes.key?(:'phone_call_enabled')

  self.phone_call_enabled = attributes[:'phone_call_enabled'] unless attributes[:'phone_call_enabled'].nil?

  self.totp_enabled = attributes[:'totpEnabled'] unless attributes[:'totpEnabled'].nil?

  raise 'You cannot provide both :totpEnabled and :totp_enabled' if attributes.key?(:'totpEnabled') && attributes.key?(:'totp_enabled')

  self.totp_enabled = attributes[:'totp_enabled'] unless attributes[:'totp_enabled'].nil?

  self.push_enabled = attributes[:'pushEnabled'] unless attributes[:'pushEnabled'].nil?

  raise 'You cannot provide both :pushEnabled and :push_enabled' if attributes.key?(:'pushEnabled') && attributes.key?(:'push_enabled')

  self.push_enabled = attributes[:'push_enabled'] unless attributes[:'push_enabled'].nil?

  self.bypass_code_enabled = attributes[:'bypassCodeEnabled'] unless attributes[:'bypassCodeEnabled'].nil?

  raise 'You cannot provide both :bypassCodeEnabled and :bypass_code_enabled' if attributes.key?(:'bypassCodeEnabled') && attributes.key?(:'bypass_code_enabled')

  self.bypass_code_enabled = attributes[:'bypass_code_enabled'] unless attributes[:'bypass_code_enabled'].nil?

  self.security_questions_enabled = attributes[:'securityQuestionsEnabled'] unless attributes[:'securityQuestionsEnabled'].nil?

  raise 'You cannot provide both :securityQuestionsEnabled and :security_questions_enabled' if attributes.key?(:'securityQuestionsEnabled') && attributes.key?(:'security_questions_enabled')

  self.security_questions_enabled = attributes[:'security_questions_enabled'] unless attributes[:'security_questions_enabled'].nil?

  self.fido_authenticator_enabled = attributes[:'fidoAuthenticatorEnabled'] unless attributes[:'fidoAuthenticatorEnabled'].nil?

  raise 'You cannot provide both :fidoAuthenticatorEnabled and :fido_authenticator_enabled' if attributes.key?(:'fidoAuthenticatorEnabled') && attributes.key?(:'fido_authenticator_enabled')

  self.fido_authenticator_enabled = attributes[:'fido_authenticator_enabled'] unless attributes[:'fido_authenticator_enabled'].nil?

  self.yubico_otp_enabled = attributes[:'yubicoOtpEnabled'] unless attributes[:'yubicoOtpEnabled'].nil?

  raise 'You cannot provide both :yubicoOtpEnabled and :yubico_otp_enabled' if attributes.key?(:'yubicoOtpEnabled') && attributes.key?(:'yubico_otp_enabled')

  self.yubico_otp_enabled = attributes[:'yubico_otp_enabled'] unless attributes[:'yubico_otp_enabled'].nil?

  self.mfa_enrollment_type = attributes[:'mfaEnrollmentType'] if attributes[:'mfaEnrollmentType']

  raise 'You cannot provide both :mfaEnrollmentType and :mfa_enrollment_type' if attributes.key?(:'mfaEnrollmentType') && attributes.key?(:'mfa_enrollment_type')

  self.mfa_enrollment_type = attributes[:'mfa_enrollment_type'] if attributes[:'mfa_enrollment_type']

  self.mfa_enabled_category = attributes[:'mfaEnabledCategory'] if attributes[:'mfaEnabledCategory']

  raise 'You cannot provide both :mfaEnabledCategory and :mfa_enabled_category' if attributes.key?(:'mfaEnabledCategory') && attributes.key?(:'mfa_enabled_category')

  self.mfa_enabled_category = attributes[:'mfa_enabled_category'] if attributes[:'mfa_enabled_category']

  self.hide_backup_factor_enabled = attributes[:'hideBackupFactorEnabled'] unless attributes[:'hideBackupFactorEnabled'].nil?

  raise 'You cannot provide both :hideBackupFactorEnabled and :hide_backup_factor_enabled' if attributes.key?(:'hideBackupFactorEnabled') && attributes.key?(:'hide_backup_factor_enabled')

  self.hide_backup_factor_enabled = attributes[:'hide_backup_factor_enabled'] unless attributes[:'hide_backup_factor_enabled'].nil?

  self.auto_enroll_email_factor_disabled = attributes[:'autoEnrollEmailFactorDisabled'] unless attributes[:'autoEnrollEmailFactorDisabled'].nil?

  raise 'You cannot provide both :autoEnrollEmailFactorDisabled and :auto_enroll_email_factor_disabled' if attributes.key?(:'autoEnrollEmailFactorDisabled') && attributes.key?(:'auto_enroll_email_factor_disabled')

  self.auto_enroll_email_factor_disabled = attributes[:'auto_enroll_email_factor_disabled'] unless attributes[:'auto_enroll_email_factor_disabled'].nil?

  self.user_enrollment_disabled_factors = attributes[:'userEnrollmentDisabledFactors'] if attributes[:'userEnrollmentDisabledFactors']

  raise 'You cannot provide both :userEnrollmentDisabledFactors and :user_enrollment_disabled_factors' if attributes.key?(:'userEnrollmentDisabledFactors') && attributes.key?(:'user_enrollment_disabled_factors')

  self.user_enrollment_disabled_factors = attributes[:'user_enrollment_disabled_factors'] if attributes[:'user_enrollment_disabled_factors']

  self.email_settings = attributes[:'emailSettings'] if attributes[:'emailSettings']

  raise 'You cannot provide both :emailSettings and :email_settings' if attributes.key?(:'emailSettings') && attributes.key?(:'email_settings')

  self.email_settings = attributes[:'email_settings'] if attributes[:'email_settings']

  self.third_party_factor = attributes[:'thirdPartyFactor'] if attributes[:'thirdPartyFactor']

  raise 'You cannot provide both :thirdPartyFactor and :third_party_factor' if attributes.key?(:'thirdPartyFactor') && attributes.key?(:'third_party_factor')

  self.third_party_factor = attributes[:'third_party_factor'] if attributes[:'third_party_factor']

  self.notification_settings = attributes[:'notificationSettings'] if attributes[:'notificationSettings']

  raise 'You cannot provide both :notificationSettings and :notification_settings' if attributes.key?(:'notificationSettings') && attributes.key?(:'notification_settings')

  self.notification_settings = attributes[:'notification_settings'] if attributes[:'notification_settings']

  self.identity_store_settings = attributes[:'identityStoreSettings'] if attributes[:'identityStoreSettings']

  raise 'You cannot provide both :identityStoreSettings and :identity_store_settings' if attributes.key?(:'identityStoreSettings') && attributes.key?(:'identity_store_settings')

  self.identity_store_settings = attributes[:'identity_store_settings'] if attributes[:'identity_store_settings']

  self.bypass_code_settings = attributes[:'bypassCodeSettings'] if attributes[:'bypassCodeSettings']

  raise 'You cannot provide both :bypassCodeSettings and :bypass_code_settings' if attributes.key?(:'bypassCodeSettings') && attributes.key?(:'bypass_code_settings')

  self.bypass_code_settings = attributes[:'bypass_code_settings'] if attributes[:'bypass_code_settings']

  self.client_app_settings = attributes[:'clientAppSettings'] if attributes[:'clientAppSettings']

  raise 'You cannot provide both :clientAppSettings and :client_app_settings' if attributes.key?(:'clientAppSettings') && attributes.key?(:'client_app_settings')

  self.client_app_settings = attributes[:'client_app_settings'] if attributes[:'client_app_settings']

  self.endpoint_restrictions = attributes[:'endpointRestrictions'] if attributes[:'endpointRestrictions']

  raise 'You cannot provide both :endpointRestrictions and :endpoint_restrictions' if attributes.key?(:'endpointRestrictions') && attributes.key?(:'endpoint_restrictions')

  self.endpoint_restrictions = attributes[:'endpoint_restrictions'] if attributes[:'endpoint_restrictions']

  self.compliance_policy = attributes[:'compliancePolicy'] if attributes[:'compliancePolicy']

  raise 'You cannot provide both :compliancePolicy and :compliance_policy' if attributes.key?(:'compliancePolicy') && attributes.key?(:'compliance_policy')

  self.compliance_policy = attributes[:'compliance_policy'] if attributes[:'compliance_policy']

  self.totp_settings = attributes[:'totpSettings'] if attributes[:'totpSettings']

  raise 'You cannot provide both :totpSettings and :totp_settings' if attributes.key?(:'totpSettings') && attributes.key?(:'totp_settings')

  self.totp_settings = attributes[:'totp_settings'] if attributes[:'totp_settings']

  self.urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings = attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings'] if attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings']

  raise 'You cannot provide both :urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings and :urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings' if attributes.key?(:'urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings') && attributes.key?(:'urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings')

  self.urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings = attributes[:'urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings'] if attributes[:'urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings']

  self.urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings = attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings'] if attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings']

  raise 'You cannot provide both :urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings and :urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings' if attributes.key?(:'urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings') && attributes.key?(:'urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings')

  self.urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings = attributes[:'urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings'] if attributes[:'urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings']
end

Instance Attribute Details

#auto_enroll_email_factor_disabled ⇒ BOOLEAN

If true, indicates that email will not be enrolled as a MFA factor automatically if it a account recovery factor

Added In: 2011192329

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


366
367
368
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 366

def auto_enroll_email_factor_disabled
  @auto_enroll_email_factor_disabled
end

#bypass_code_enabled ⇒ BOOLEAN

[Required] If true, indicates that Bypass Code is enabled for authentication

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


261
262
263
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 261

def bypass_code_enabled
  @bypass_code_enabled
end

#bypass_code_settings ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsBypassCodeSettings

This attribute is required.

Returns:



398
399
400
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 398

def bypass_code_settings
  @bypass_code_settings
end

#client_app_settings ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsClientAppSettings

This attribute is required.

Returns:



402
403
404
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 402

def client_app_settings
  @client_app_settings
end

#compartment_ocid ⇒ String

OCI Compartment Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


165
166
167
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 165

def compartment_ocid
  @compartment_ocid
end

#compliance_policy ⇒ Array<OCI::IdentityDomains::Models::AuthenticationFactorSettingsCompliancePolicy>

[Required] Compliance Policy that defines actions to be taken when a condition is violated

SCIM++ Properties: - idcsCompositeKey: [name] - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: complex - uniqueness: none

Returns:



420
421
422
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 420

def compliance_policy
  @compliance_policy
end

#delete_in_progress ⇒ BOOLEAN

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


123
124
125
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 123

def delete_in_progress
  @delete_in_progress
end

#domain_ocid ⇒ String

OCI Domain Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


151
152
153
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 151

def domain_ocid
  @domain_ocid
end

#email_enabled ⇒ BOOLEAN

If true, indicates that the EMAIL channel is enabled for authentication

Added In: 18.1.2

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


194
195
196
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 194

def email_enabled
  @email_enabled
end

#email_settings ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsEmailSettings

Returns:



384
385
386
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 384

def email_settings
  @email_settings
end

#endpoint_restrictions ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsEndpointRestrictions

This attribute is required.

Returns:



406
407
408
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 406

def endpoint_restrictions
  @endpoint_restrictions
end

#fido_authenticator_enabled ⇒ BOOLEAN

If true, indicates that the Fido Authenticator channels are enabled for authentication

Added In: 2009232244

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


289
290
291
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 289

def fido_authenticator_enabled
  @fido_authenticator_enabled
end

#hide_backup_factor_enabled ⇒ BOOLEAN

If true, indicates that 'Show backup factor(s)' button will be hidden during authentication

Added In: 19.3.3

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


351
352
353
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 351

def hide_backup_factor_enabled
  @hide_backup_factor_enabled
end

#id ⇒ String

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 45

def id
  @id
end

#idcs_created_by ⇒ OCI::IdentityDomains::Models::IdcsCreatedBy

Returns:



79
80
81
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 79

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_by ⇒ OCI::IdentityDomains::Models::IdcsLastModifiedBy

Returns:



82
83
84
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 82

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_release ⇒ String

The release number when the resource was upgraded.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 137

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_prevented_operations ⇒ Array<String>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

SCIM++ Properties: - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (Array<String>) 


95
96
97
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 95

def idcs_prevented_operations
  @idcs_prevented_operations
end

#identity_store_settings ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsIdentityStoreSettings

Returns:



394
395
396
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 394

def identity_store_settings
  @identity_store_settings
end

#meta ⇒ OCI::IdentityDomains::Models::Meta

Returns:



76
77
78
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 76

def meta
  @meta
end

#mfa_enabled_category ⇒ String

Specifies the category of people for whom Multi-Factor Authentication is enabled. This is a readOnly attribute which reflects the value of mfaEnabledCategory attribute in SsoSettings

Deprecated Since: 18.1.2

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


336
337
338
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 336

def mfa_enabled_category
  @mfa_enabled_category
end

#mfa_enrollment_type ⇒ String

[Required] Specifies if Multi-Factor Authentication enrollment is mandatory or optional for a user

Deprecated Since: 18.1.2

SCIM++ Properties: - idcsCanonicalValueSourceFilter: attrName eq "mfaEnrollmentType" and attrValues.value eq "$(mfaEnrollmentType)" - idcsCanonicalValueSourceResourceType: AllowedValue - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


321
322
323
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 321

def mfa_enrollment_type
  @mfa_enrollment_type
end

#notification_settings ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsNotificationSettings

This attribute is required.

Returns:



391
392
393
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 391

def notification_settings
  @notification_settings
end

#ocid ⇒ String

Unique OCI identifier for the SCIM Resource.

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 59

def ocid
  @ocid
end

#phone_call_enabled ⇒ BOOLEAN

If true, indicates that the phone (PHONE_CALL) channel is enabled for authentication

Added In: 20.1.3

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


222
223
224
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 222

def phone_call_enabled
  @phone_call_enabled
end

#push_enabled ⇒ BOOLEAN

[Required] If true, indicates that the Mobile App Push Notification channel is enabled for authentication

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


248
249
250
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 248

def push_enabled
  @push_enabled
end

#schemas ⇒ Array<String>

[Required] REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (Array<String>) 


73
74
75
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 73

def schemas
  @schemas
end

#security_questions_enabled ⇒ BOOLEAN

[Required] If true, indicates that Security Questions are enabled for authentication

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


274
275
276
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 274

def security_questions_enabled
  @security_questions_enabled
end

#sms_enabled ⇒ BOOLEAN

[Required] If true, indicates that the Short Message Service (SMS) channel is enabled for authentication

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


207
208
209
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 207

def sms_enabled
  @sms_enabled
end

#tags ⇒ Array<OCI::IdentityDomains::Models::Tags>

A list of tags on this resource.

SCIM++ Properties: - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Returns:



109
110
111
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 109

def tags
  @tags
end

#tenancy_ocid ⇒ String

OCI Tenant Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


179
180
181
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 179

def tenancy_ocid
  @tenancy_ocid
end

#third_party_factor ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsThirdPartyFactor

Returns:



387
388
389
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 387

def third_party_factor
  @third_party_factor
end

#totp_enabled ⇒ BOOLEAN

[Required] If true, indicates that the Mobile App One Time Passcode channel is enabled for authentication

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


235
236
237
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 235

def totp_enabled
  @totp_enabled
end

#totp_settings ⇒ OCI::IdentityDomains::Models::AuthenticationFactorSettingsTotpSettings

This attribute is required.

Returns:



424
425
426
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 424

def totp_settings
  @totp_settings
end

#urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings ⇒ OCI::IdentityDomains::Models::ExtensionFidoAuthenticationFactorSettings

Returns:



430
431
432
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 430

def urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings
  @urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings
end

#urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings ⇒ OCI::IdentityDomains::Models::ExtensionThirdPartyAuthenticationFactorSettings

Returns:



427
428
429
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 427

def urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings
  @urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings
end

#user_enrollment_disabled_factors ⇒ Array<String>

Factors for which enrollment should be blocked for End User

Added In: 2012271618

SCIM++ Properties: - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (Array<String>) 


381
382
383
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 381

def user_enrollment_disabled_factors
  @user_enrollment_disabled_factors
end

#yubico_otp_enabled ⇒ BOOLEAN

If true, indicates that the Yubico OTP is enabled for authentication

Added In: 2109090424

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


304
305
306
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 304

def yubico_otp_enabled
  @yubico_otp_enabled
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 433

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'ocid': :'ocid',
    'schemas': :'schemas',
    'meta': :'meta',
    'idcs_created_by': :'idcsCreatedBy',
    'idcs_last_modified_by': :'idcsLastModifiedBy',
    'idcs_prevented_operations': :'idcsPreventedOperations',
    'tags': :'tags',
    'delete_in_progress': :'deleteInProgress',
    'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease',
    'domain_ocid': :'domainOcid',
    'compartment_ocid': :'compartmentOcid',
    'tenancy_ocid': :'tenancyOcid',
    'email_enabled': :'emailEnabled',
    'sms_enabled': :'smsEnabled',
    'phone_call_enabled': :'phoneCallEnabled',
    'totp_enabled': :'totpEnabled',
    'push_enabled': :'pushEnabled',
    'bypass_code_enabled': :'bypassCodeEnabled',
    'security_questions_enabled': :'securityQuestionsEnabled',
    'fido_authenticator_enabled': :'fidoAuthenticatorEnabled',
    'yubico_otp_enabled': :'yubicoOtpEnabled',
    'mfa_enrollment_type': :'mfaEnrollmentType',
    'mfa_enabled_category': :'mfaEnabledCategory',
    'hide_backup_factor_enabled': :'hideBackupFactorEnabled',
    'auto_enroll_email_factor_disabled': :'autoEnrollEmailFactorDisabled',
    'user_enrollment_disabled_factors': :'userEnrollmentDisabledFactors',
    'email_settings': :'emailSettings',
    'third_party_factor': :'thirdPartyFactor',
    'notification_settings': :'notificationSettings',
    'identity_store_settings': :'identityStoreSettings',
    'bypass_code_settings': :'bypassCodeSettings',
    'client_app_settings': :'clientAppSettings',
    'endpoint_restrictions': :'endpointRestrictions',
    'compliance_policy': :'compliancePolicy',
    'totp_settings': :'totpSettings',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings': :'urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings': :'urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 479

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'ocid': :'String',
    'schemas': :'Array<String>',
    'meta': :'OCI::IdentityDomains::Models::Meta',
    'idcs_created_by': :'OCI::IdentityDomains::Models::IdcsCreatedBy',
    'idcs_last_modified_by': :'OCI::IdentityDomains::Models::IdcsLastModifiedBy',
    'idcs_prevented_operations': :'Array<String>',
    'tags': :'Array<OCI::IdentityDomains::Models::Tags>',
    'delete_in_progress': :'BOOLEAN',
    'idcs_last_upgraded_in_release': :'String',
    'domain_ocid': :'String',
    'compartment_ocid': :'String',
    'tenancy_ocid': :'String',
    'email_enabled': :'BOOLEAN',
    'sms_enabled': :'BOOLEAN',
    'phone_call_enabled': :'BOOLEAN',
    'totp_enabled': :'BOOLEAN',
    'push_enabled': :'BOOLEAN',
    'bypass_code_enabled': :'BOOLEAN',
    'security_questions_enabled': :'BOOLEAN',
    'fido_authenticator_enabled': :'BOOLEAN',
    'yubico_otp_enabled': :'BOOLEAN',
    'mfa_enrollment_type': :'String',
    'mfa_enabled_category': :'String',
    'hide_backup_factor_enabled': :'BOOLEAN',
    'auto_enroll_email_factor_disabled': :'BOOLEAN',
    'user_enrollment_disabled_factors': :'Array<String>',
    'email_settings': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsEmailSettings',
    'third_party_factor': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsThirdPartyFactor',
    'notification_settings': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsNotificationSettings',
    'identity_store_settings': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsIdentityStoreSettings',
    'bypass_code_settings': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsBypassCodeSettings',
    'client_app_settings': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsClientAppSettings',
    'endpoint_restrictions': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsEndpointRestrictions',
    'compliance_policy': :'Array<OCI::IdentityDomains::Models::AuthenticationFactorSettingsCompliancePolicy>',
    'totp_settings': :'OCI::IdentityDomains::Models::AuthenticationFactorSettingsTotpSettings',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings': :'OCI::IdentityDomains::Models::ExtensionThirdPartyAuthenticationFactorSettings',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings': :'OCI::IdentityDomains::Models::ExtensionFidoAuthenticationFactorSettings'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 830

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    ocid == other.ocid &&
    schemas == other.schemas &&
    meta == other.meta &&
    idcs_created_by == other.idcs_created_by &&
    idcs_last_modified_by == other.idcs_last_modified_by &&
    idcs_prevented_operations == other.idcs_prevented_operations &&
    tags == other.tags &&
    delete_in_progress == other.delete_in_progress &&
    idcs_last_upgraded_in_release == other.idcs_last_upgraded_in_release &&
    domain_ocid == other.domain_ocid &&
    compartment_ocid == other.compartment_ocid &&
    tenancy_ocid == other.tenancy_ocid &&
    email_enabled == other.email_enabled &&
    sms_enabled == other.sms_enabled &&
    phone_call_enabled == other.phone_call_enabled &&
    totp_enabled == other.totp_enabled &&
    push_enabled == other.push_enabled &&
    bypass_code_enabled == other.bypass_code_enabled &&
    security_questions_enabled == other.security_questions_enabled &&
    fido_authenticator_enabled == other.fido_authenticator_enabled &&
    yubico_otp_enabled == other.yubico_otp_enabled &&
    mfa_enrollment_type == other.mfa_enrollment_type &&
    mfa_enabled_category == other.mfa_enabled_category &&
    hide_backup_factor_enabled == other.hide_backup_factor_enabled &&
    auto_enroll_email_factor_disabled == other.auto_enroll_email_factor_disabled &&
    user_enrollment_disabled_factors == other.user_enrollment_disabled_factors &&
    email_settings == other.email_settings &&
    third_party_factor == other.third_party_factor &&
    notification_settings == other.notification_settings &&
    identity_store_settings == other.identity_store_settings &&
    bypass_code_settings == other.bypass_code_settings &&
    client_app_settings == other.client_app_settings &&
    endpoint_restrictions == other.endpoint_restrictions &&
    compliance_policy == other.compliance_policy &&
    totp_settings == other.totp_settings &&
    urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings == other.urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings &&
    urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings == other.urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 897

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


877
878
879
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 877

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



886
887
888
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 886

def hash
  [id, ocid, schemas, meta, idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, tags, delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, email_enabled, sms_enabled, phone_call_enabled, totp_enabled, push_enabled, bypass_code_enabled, security_questions_enabled, fido_authenticator_enabled, yubico_otp_enabled, mfa_enrollment_type, mfa_enabled_category, hide_backup_factor_enabled, auto_enroll_email_factor_disabled, user_enrollment_disabled_factors, email_settings, third_party_factor, notification_settings, identity_store_settings, bypass_code_settings, client_app_settings, endpoint_restrictions, compliance_policy, totp_settings, urn_ietf_params_scim_schemas_oracle_idcs_extension_third_party_authentication_factor_settings, urn_ietf_params_scim_schemas_oracle_idcs_extension_fido_authentication_factor_settings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



930
931
932
933
934
935
936
937
938
939
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 930

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



924
925
926
 
# File 'lib/oci/identity_domains/models/authentication_factor_setting.rb', line 924

def to_s
  to_hash.to_s
end