Class: OCI::IdentityDomains::Models::ExtensionFidoAuthenticationFactorSettings

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

Overview

This extension defines attributes used to manage Multi-Factor Authentication settings of fido authentication

Constant Summary collapse

ATTESTATION_ENUM = 
[
  ATTESTATION_NONE = 'NONE'.freeze,
  ATTESTATION_DIRECT = 'DIRECT'.freeze,
  ATTESTATION_INDIRECT = 'INDIRECT'.freeze,
  ATTESTATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTHENTICATOR_SELECTION_ATTACHMENT_ENUM = 
[
  AUTHENTICATOR_SELECTION_ATTACHMENT_PLATFORM = 'PLATFORM'.freeze,
  AUTHENTICATOR_SELECTION_ATTACHMENT_CROSS_PLATFORM = 'CROSS-PLATFORM'.freeze,
  AUTHENTICATOR_SELECTION_ATTACHMENT_BOTH = 'BOTH'.freeze,
  AUTHENTICATOR_SELECTION_ATTACHMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTHENTICATOR_SELECTION_USER_VERIFICATION_ENUM = 
[
  AUTHENTICATOR_SELECTION_USER_VERIFICATION_REQUIRED = 'REQUIRED'.freeze,
  AUTHENTICATOR_SELECTION_USER_VERIFICATION_PREFERRED = 'PREFERRED'.freeze,
  AUTHENTICATOR_SELECTION_USER_VERIFICATION_DISCOURAGED = 'DISCOURAGED'.freeze,
  AUTHENTICATOR_SELECTION_USER_VERIFICATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTHENTICATOR_SELECTION_RESIDENT_KEY_ENUM = 
[
  AUTHENTICATOR_SELECTION_RESIDENT_KEY_REQUIRED = 'REQUIRED'.freeze,
  AUTHENTICATOR_SELECTION_RESIDENT_KEY_PREFERRED = 'PREFERRED'.freeze,
  AUTHENTICATOR_SELECTION_RESIDENT_KEY_DISCOURAGED = 'DISCOURAGED'.freeze,
  AUTHENTICATOR_SELECTION_RESIDENT_KEY_NONE = 'NONE'.freeze,
  AUTHENTICATOR_SELECTION_RESIDENT_KEY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PUBLIC_KEY_TYPES_ENUM = 
[
  PUBLIC_KEY_TYPES_RS1 = 'RS1'.freeze,
  PUBLIC_KEY_TYPES_RS256 = 'RS256'.freeze,
  PUBLIC_KEY_TYPES_ES256 = 'ES256'.freeze,
  PUBLIC_KEY_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionFidoAuthenticationFactorSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 236

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

  self.authenticator_selection_attachment = attributes[:'authenticatorSelectionAttachment'] if attributes[:'authenticatorSelectionAttachment']

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

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

  self.authenticator_selection_user_verification = attributes[:'authenticatorSelectionUserVerification'] if attributes[:'authenticatorSelectionUserVerification']

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

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

  self.authenticator_selection_resident_key = attributes[:'authenticatorSelectionResidentKey'] if attributes[:'authenticatorSelectionResidentKey']

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

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

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

  self.authenticator_selection_require_resident_key = attributes[:'authenticatorSelectionRequireResidentKey'] unless attributes[:'authenticatorSelectionRequireResidentKey'].nil?

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

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

  self.public_key_types = attributes[:'publicKeyTypes'] if attributes[:'publicKeyTypes']

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

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

  self.exclude_credentials = attributes[:'excludeCredentials'] unless attributes[:'excludeCredentials'].nil?

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

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

  self.domain_validation_level = attributes[:'domainValidationLevel'] if attributes[:'domainValidationLevel']

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

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

Instance Attribute Details

#attestation ⇒ String

[Required] Attribute used to define the type of attestation required.

Added In: 2009232244

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

Returns:

  • (String) 


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

def attestation
  @attestation
end

#authenticator_selection_attachment ⇒ String

[Required] Attribute used to define authenticator selection attachment.

Added In: 2009232244

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

Returns:

  • (String) 


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

def authenticator_selection_attachment
  @authenticator_selection_attachment
end

#authenticator_selection_require_resident_key ⇒ BOOLEAN

[Required] Flag used to indicate authenticator selection is required or not

Added In: 2009232244

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

Returns:

  • (BOOLEAN) 


138
139
140
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 138

def authenticator_selection_require_resident_key
  @authenticator_selection_require_resident_key
end

#authenticator_selection_resident_key ⇒ String

[Required] Attribute used to define authenticator selection resident key requirement.

Added In: 2009232244

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

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 106

def authenticator_selection_resident_key
  @authenticator_selection_resident_key
end

#authenticator_selection_user_verification ⇒ String

[Required] Attribute used to define authenticator selection verification.

Added In: 2009232244

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

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 91

def authenticator_selection_user_verification
  @authenticator_selection_user_verification
end

#domain_validation_level ⇒ Integer

Number of domain levels Oracle Identity Cloud Service should use for origin comparision

Added In: 2109020413

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - idcsMaxValue: 2 - idcsMinValue: 0 - required: false - returned: default - type: integer - uniqueness: none

Returns:

  • (Integer) 


185
186
187
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 185

def domain_validation_level
  @domain_validation_level
end

#exclude_credentials ⇒ BOOLEAN

[Required] Flag used to indicate whether we need to restrict creation of multiple credentials in same authenticator

Added In: 2009232244

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

Returns:

  • (BOOLEAN) 


168
169
170
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 168

def exclude_credentials
  @exclude_credentials
end

#public_key_types ⇒ Array<String>

[Required] List of server supported public key algorithms

Added In: 2009232244

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

Returns:

  • (Array<String>) 


153
154
155
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 153

def public_key_types
  @public_key_types
end

#timeout ⇒ Integer

[Required] Timeout for the fido authentication to complete

Added In: 2009232244

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - idcsMaxValue: 600000 - idcsMinValue: 10000 - required: true - returned: default - type: integer - uniqueness: none

Returns:

  • (Integer) 


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

def timeout
  @timeout
end

Class Method Details

.attribute_map ⇒ Object

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 188

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'attestation': :'attestation',
    'authenticator_selection_attachment': :'authenticatorSelectionAttachment',
    'authenticator_selection_user_verification': :'authenticatorSelectionUserVerification',
    'authenticator_selection_resident_key': :'authenticatorSelectionResidentKey',
    'timeout': :'timeout',
    'authenticator_selection_require_resident_key': :'authenticatorSelectionRequireResidentKey',
    'public_key_types': :'publicKeyTypes',
    'exclude_credentials': :'excludeCredentials',
    'domain_validation_level': :'domainValidationLevel'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 205

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'attestation': :'String',
    'authenticator_selection_attachment': :'String',
    'authenticator_selection_user_verification': :'String',
    'authenticator_selection_resident_key': :'String',
    'timeout': :'Integer',
    'authenticator_selection_require_resident_key': :'BOOLEAN',
    'public_key_types': :'Array<String>',
    'exclude_credentials': :'BOOLEAN',
    'domain_validation_level': :'Integer'
    # 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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 368

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

  self.class == other.class &&
    attestation == other.attestation &&
    authenticator_selection_attachment == other.authenticator_selection_attachment &&
    authenticator_selection_user_verification == other.authenticator_selection_user_verification &&
    authenticator_selection_resident_key == other.authenticator_selection_resident_key &&
    timeout == other.timeout &&
    authenticator_selection_require_resident_key == other.authenticator_selection_require_resident_key &&
    public_key_types == other.public_key_types &&
    exclude_credentials == other.exclude_credentials &&
    domain_validation_level == other.domain_validation_level
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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 406

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


386
387
388
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 386

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



395
396
397
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 395

def hash
  [attestation, authenticator_selection_attachment, authenticator_selection_user_verification, authenticator_selection_resident_key, timeout, authenticator_selection_require_resident_key, public_key_types, exclude_credentials, domain_validation_level].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



439
440
441
442
443
444
445
446
447
448
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 439

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



433
434
435
 
# File 'lib/oci/identity_domains/models/extension_fido_authentication_factor_settings.rb', line 433

def to_s
  to_hash.to_s
end