Class: OCI::IdentityDomains::Models::AuthenticationFactorSettingsEmailSettings

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

Overview

Settings related to Email Factor, such as enabled email magic link factor, custom url for Email Link

Added In: 20.1.3

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticationFactorSettingsEmailSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 80

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.email_link_enabled = attributes[:'emailLinkEnabled'] unless attributes[:'emailLinkEnabled'].nil?

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

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

  self.email_link_custom_url = attributes[:'emailLinkCustomUrl'] if attributes[:'emailLinkCustomUrl']

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

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

Instance Attribute Details

Custom redirect Url which will be used in email link

Added In: 20.1.3

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

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 50

def email_link_custom_url
  @email_link_custom_url
end

#email_link_enabled ⇒ BOOLEAN

[Required] Specifies whether Email link is enabled or not.

Added In: 20.1.3

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

Returns:

  • (BOOLEAN) 


35
36
37
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 35

def email_link_enabled
  @email_link_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'email_link_enabled': :'emailLinkEnabled',
    'email_link_custom_url': :'emailLinkCustomUrl'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 63

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'email_link_enabled': :'BOOLEAN',
    'email_link_custom_url': :'String'
    # 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



106
107
108
109
110
111
112
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 106

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

  self.class == other.class &&
    email_link_enabled == other.email_link_enabled &&
    email_link_custom_url == other.email_link_custom_url
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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 137

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


117
118
119
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 126

def hash
  [email_link_enabled, email_link_custom_url].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 170

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



164
165
166
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_email_settings.rb', line 164

def to_s
  to_hash.to_s
end