Class: OCI::IdentityDomains::Models::MyDeviceAuthenticationFactors

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

Overview

Authentication Factors

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_EMAIL = 'EMAIL'.freeze,
  TYPE_SMS = 'SMS'.freeze,
  TYPE_TOTP = 'TOTP'.freeze,
  TYPE_PUSH = 'PUSH'.freeze,
  TYPE_OFFLINETOTP = 'OFFLINETOTP'.freeze,
  TYPE_VOICE = 'VOICE'.freeze,
  TYPE_PHONE_CALL = 'PHONE_CALL'.freeze,
  TYPE_THIRDPARTY = 'THIRDPARTY'.freeze,
  TYPE_FIDO_AUTHENTICATOR = 'FIDO_AUTHENTICATOR'.freeze,
  TYPE_YUBICO_OTP = 'YUBICO_OTP'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_INITIATED = 'INITIATED'.freeze,
  STATUS_INPROGRESS = 'INPROGRESS'.freeze,
  STATUS_ENROLLED = 'ENROLLED'.freeze,
  STATUS_LOCKED = 'LOCKED'.freeze,
  STATUS_INACTIVE = 'INACTIVE'.freeze,
  STATUS_BLOCKED = 'BLOCKED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MyDeviceAuthenticationFactors

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :status (String) —

    The value to assign to the #status property

  • :public_key (String) —

    The value to assign to the #public_key property



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

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

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

  self.public_key = attributes[:'publicKey'] if attributes[:'publicKey']

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

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

Instance Attribute Details

#public_key ⇒ String

Authentication Factor public key issued by client

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

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 80

def public_key
  @public_key
end

#status ⇒ String

Authentication Factor Status

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

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 65

def status
  @status
end

#type ⇒ String

[Required] Authentication Factor Type

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

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'status': :'status',
    'public_key': :'publicKey'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 94

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'status': :'String',
    'public_key': :'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



163
164
165
166
167
168
169
170
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 163

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

  self.class == other.class &&
    type == other.type &&
    status == other.status &&
    public_key == other.public_key
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 195

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


175
176
177
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 175

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 184

def hash
  [type, status, public_key].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/identity_domains/models/my_device_authentication_factors.rb', line 228

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



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

def to_s
  to_hash.to_s
end