Class: OCI::IdentityDomains::Models::UserExtSecQuestions

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

Overview

The schema used to mnage security question and answers provided by a user for account recovery and/or MFA. While setting up security questions, a user can also provide a hint for the answer.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserExtSecQuestions

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :value (String) —

    The value to assign to the #value property

  • :ref (String) —

    The value to assign to the #ref property

  • :answer (String) —

    The value to assign to the #answer property

  • :hint_text (String) —

    The value to assign to the #hint_text property



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 110

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.value = attributes[:'value'] if attributes[:'value']

  self.ref = attributes[:'$ref'] if attributes[:'$ref']

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

  self.hint_text = attributes[:'hintText'] if attributes[:'hintText']

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

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

Instance Attribute Details

#answer ⇒ String

[Required] The answer provided by a user for a security question.

SCIM++ Properties: - idcsCsvAttributeName: Answer - idcsSearchable: false - idcsSensitive: hash - multiValued: false - mutability: writeOnly - required: true - returned: never - type: string - uniqueness: none - idcsPii: true

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 61

def answer
  @answer
end

#hint_text ⇒ String

The hint for an answer that's given by user when setting up a security question.

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

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 74

def hint_text
  @hint_text
end

#ref ⇒ String

The URI of the corresponding Security Question resource.

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

Returns:

  • (String) 


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

def ref
  @ref
end

#value ⇒ String

[Required] The identifier of the question selected by the user when setting up a security question.

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 32

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'ref': :'$ref',
    'answer': :'answer',
    'hint_text': :'hintText'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'ref': :'String',
    'answer': :'String',
    'hint_text': :'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



136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 136

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

  self.class == other.class &&
    value == other.value &&
    ref == other.ref &&
    answer == other.answer &&
    hint_text == other.hint_text
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 169

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


149
150
151
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 158

def hash
  [value, ref, answer, hint_text].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 202

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



196
197
198
 
# File 'lib/oci/identity_domains/models/user_ext_sec_questions.rb', line 196

def to_s
  to_hash.to_s
end