Class: OCI::IdentityDomains::Models::AuthenticationFactorSettingsBypassCodeSettings

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

Overview

Settings related to the bypass code, such as bypass code length, bypass code expiry, max active bypass codes, and so on

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticationFactorSettingsBypassCodeSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 146

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

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

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

  self.help_desk_generation_enabled = attributes[:'helpDeskGenerationEnabled'] unless attributes[:'helpDeskGenerationEnabled'].nil?

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

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

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

  self.max_active = attributes[:'maxActive'] if attributes[:'maxActive']

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

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

  self.help_desk_code_expiry_in_mins = attributes[:'helpDeskCodeExpiryInMins'] if attributes[:'helpDeskCodeExpiryInMins']

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

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

  self.help_desk_max_usage = attributes[:'helpDeskMaxUsage'] if attributes[:'helpDeskMaxUsage']

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

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

Instance Attribute Details

#help_desk_code_expiry_in_mins ⇒ Integer

[Required] Expiry (in minutes) of any bypass code that is generated by the help desk

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

Returns:

  • (Integer) 


89
90
91
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 89

def help_desk_code_expiry_in_mins
  @help_desk_code_expiry_in_mins
end

#help_desk_generation_enabled ⇒ BOOLEAN

[Required] If true, indicates that help desk bypass code generation is enabled

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

Returns:

  • (BOOLEAN) 


44
45
46
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 44

def help_desk_generation_enabled
  @help_desk_generation_enabled
end

#help_desk_max_usage ⇒ Integer

[Required] The maximum number of times that any bypass code that is generated by the help desk can be used

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

Returns:

  • (Integer) 


104
105
106
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 104

def help_desk_max_usage
  @help_desk_max_usage
end

#length ⇒ Integer

[Required] Exact length of the bypass code to be generated

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

Returns:

  • (Integer) 


59
60
61
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 59

def length
  @length
end

#max_active ⇒ Integer

[Required] The maximum number of bypass codes that can be issued to any user

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

Returns:

  • (Integer) 


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

def max_active
  @max_active
end

#self_service_generation_enabled ⇒ BOOLEAN

[Required] If true, indicates that self-service bypass code generation is enabled

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

Returns:

  • (BOOLEAN) 


31
32
33
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 31

def self_service_generation_enabled
  @self_service_generation_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 107

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'self_service_generation_enabled': :'selfServiceGenerationEnabled',
    'help_desk_generation_enabled': :'helpDeskGenerationEnabled',
    'length': :'length',
    'max_active': :'maxActive',
    'help_desk_code_expiry_in_mins': :'helpDeskCodeExpiryInMins',
    'help_desk_max_usage': :'helpDeskMaxUsage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 121

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'self_service_generation_enabled': :'BOOLEAN',
    'help_desk_generation_enabled': :'BOOLEAN',
    'length': :'Integer',
    'max_active': :'Integer',
    'help_desk_code_expiry_in_mins': :'Integer',
    'help_desk_max_usage': :'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



192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 192

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

  self.class == other.class &&
    self_service_generation_enabled == other.self_service_generation_enabled &&
    help_desk_generation_enabled == other.help_desk_generation_enabled &&
    length == other.length &&
    max_active == other.max_active &&
    help_desk_code_expiry_in_mins == other.help_desk_code_expiry_in_mins &&
    help_desk_max_usage == other.help_desk_max_usage
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 227

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


207
208
209
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 216

def hash
  [self_service_generation_enabled, help_desk_generation_enabled, length, max_active, help_desk_code_expiry_in_mins, help_desk_max_usage].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 260

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



254
255
256
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_bypass_code_settings.rb', line 254

def to_s
  to_hash.to_s
end