Class: OCI::IdentityDomains::Models::ExtensionPasswordlessUser

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

Overview

This extension defines attributes used to manage Passwordless-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA.

Constant Summary collapse

FACTOR_TYPE_ENUM = 
[
  FACTOR_TYPE_EMAIL = 'EMAIL'.freeze,
  FACTOR_TYPE_SMS = 'SMS'.freeze,
  FACTOR_TYPE_PHONE_CALL = 'PHONE_CALL'.freeze,
  FACTOR_TYPE_TOTP = 'TOTP'.freeze,
  FACTOR_TYPE_PUSH = 'PUSH'.freeze,
  FACTOR_TYPE_OFFLINETOTP = 'OFFLINETOTP'.freeze,
  FACTOR_TYPE_SECURITY_QUESTIONS = 'SECURITY_QUESTIONS'.freeze,
  FACTOR_TYPE_VOICE = 'VOICE'.freeze,
  FACTOR_TYPE_USERNAME_PASSWORD = 'USERNAME_PASSWORD'.freeze,
  FACTOR_TYPE_THIRDPARTY = 'THIRDPARTY'.freeze,
  FACTOR_TYPE_FIDO_AUTHENTICATOR = 'FIDO_AUTHENTICATOR'.freeze,
  FACTOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionPasswordlessUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 93

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

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

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

  self.factor_method = attributes[:'factorMethod'] if attributes[:'factorMethod']

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

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

  self.factor_identifier = attributes[:'factorIdentifier'] if attributes[:'factorIdentifier']

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

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

Instance Attribute Details

#factor_identifier ⇒ OCI::IdentityDomains::Models::UserExtFactorIdentifier

Returns:



60
61
62
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 60

def factor_identifier
  @factor_identifier
end

#factor_method ⇒ String

Authentication Factor Method

Added In: 2009232244

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 57

def factor_method
  @factor_method
end

#factor_type ⇒ String

Authentication Factor Type

Added In: 20.1.3

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

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 41

def factor_type
  @factor_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'factor_type': :'factorType',
    'factor_method': :'factorMethod',
    'factor_identifier': :'factorIdentifier'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'factor_type': :'String',
    'factor_method': :'String',
    'factor_identifier': :'OCI::IdentityDomains::Models::UserExtFactorIdentifier'
    # 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



138
139
140
141
142
143
144
145
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 138

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

  self.class == other.class &&
    factor_type == other.factor_type &&
    factor_method == other.factor_method &&
    factor_identifier == other.factor_identifier
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



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

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


150
151
152
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 150

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 159

def hash
  [factor_type, factor_method, factor_identifier].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



197
198
199
 
# File 'lib/oci/identity_domains/models/extension_passwordless_user.rb', line 197

def to_s
  to_hash.to_s
end