Class: OCI::IdentityDomains::Models::ExtensionUserStateUser

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

Overview

This extension defines the attributes used to manage account passwords within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionUserStateUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 175

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

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

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

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

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

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

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

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

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

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

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

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

  self.recovery_attempts = attributes[:'recoveryAttempts'] if attributes[:'recoveryAttempts']

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

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

  self.recovery_enroll_attempts = attributes[:'recoveryEnrollAttempts'] if attributes[:'recoveryEnrollAttempts']

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

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

  self.max_concurrent_sessions = attributes[:'maxConcurrentSessions'] if attributes[:'maxConcurrentSessions']

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

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

  self.recovery_locked = attributes[:'recoveryLocked'] if attributes[:'recoveryLocked']

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

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

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

Instance Attribute Details

#last_failed_login_date ⇒ String

The last failed login date.

SCIM++ Properties: - idcsSearchable: false - idcsAllowUpdatesInReadOnlyMode: true - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - required: false - returned: request - type: dateTime - uniqueness: none

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 54

def 
  @last_failed_login_date
end

#last_successful_login_date ⇒ String

The last successful login date.

SCIM++ Properties: - idcsSearchable: true - idcsAllowUpdatesInReadOnlyMode: true - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - required: false - returned: request - type: dateTime - uniqueness: none

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 24

def 
  @last_successful_login_date
end

#locked ⇒ OCI::IdentityDomains::Models::UserExtLocked

Returns:



124
125
126
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 124

def locked
  @locked
end

#login_attempts ⇒ Integer

The number of failed login attempts. The value is reset to 0 after a successful login.

SCIM++ Properties: - idcsSearchable: false - idcsAllowUpdatesInReadOnlyMode: true - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - idcsRequiresImmediateReadAfterWriteForAccessFlows: true - required: false - returned: request - type: integer - uniqueness: none

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 70

def 
  @login_attempts
end

#max_concurrent_sessions ⇒ Integer

The maximum number of concurrent sessions for a user.

Added In: 20.1.3

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

Returns:

  • (Integer) 


118
119
120
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 118

def max_concurrent_sessions
  @max_concurrent_sessions
end

#previous_successful_login_date ⇒ String

The previous successful login date.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - required: false - returned: request - type: dateTime - uniqueness: none

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 39

def 
  @previous_successful_login_date
end

#recovery_attempts ⇒ Integer

The number of failed recovery attempts. The value is reset to 0 after a successful login.

Added In: 19.1.4

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - required: false - returned: request - type: integer - uniqueness: none

Returns:

  • (Integer) 


86
87
88
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 86

def recovery_attempts
  @recovery_attempts
end

#recovery_enroll_attempts ⇒ Integer

The number of failed account recovery enrollment attempts.

Added In: 19.1.4

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: integer - uniqueness: none

Returns:

  • (Integer) 


101
102
103
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 101

def recovery_enroll_attempts
  @recovery_enroll_attempts
end

#recovery_locked ⇒ OCI::IdentityDomains::Models::UserExtRecoveryLocked

Returns:



121
122
123
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 121

def recovery_locked
  @recovery_locked
end

Class Method Details

.attribute_map ⇒ Object

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 127

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'last_successful_login_date': :'lastSuccessfulLoginDate',
    'previous_successful_login_date': :'previousSuccessfulLoginDate',
    'last_failed_login_date': :'lastFailedLoginDate',
    'login_attempts': :'loginAttempts',
    'recovery_attempts': :'recoveryAttempts',
    'recovery_enroll_attempts': :'recoveryEnrollAttempts',
    'max_concurrent_sessions': :'maxConcurrentSessions',
    'recovery_locked': :'recoveryLocked',
    'locked': :'locked'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 144

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'last_successful_login_date': :'String',
    'previous_successful_login_date': :'String',
    'last_failed_login_date': :'String',
    'login_attempts': :'Integer',
    'recovery_attempts': :'Integer',
    'recovery_enroll_attempts': :'Integer',
    'max_concurrent_sessions': :'Integer',
    'recovery_locked': :'OCI::IdentityDomains::Models::UserExtRecoveryLocked',
    'locked': :'OCI::IdentityDomains::Models::UserExtLocked'
    # 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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 239

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

  self.class == other.class &&
     == other. &&
     == other. &&
     == other. &&
     == other. &&
    recovery_attempts == other.recovery_attempts &&
    recovery_enroll_attempts == other.recovery_enroll_attempts &&
    max_concurrent_sessions == other.max_concurrent_sessions &&
    recovery_locked == other.recovery_locked &&
    locked == other.locked
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 277

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


257
258
259
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 257

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 266

def hash
  [, , , , recovery_attempts, recovery_enroll_attempts, max_concurrent_sessions, recovery_locked, locked].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 310

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



304
305
306
 
# File 'lib/oci/identity_domains/models/extension_user_state_user.rb', line 304

def to_s
  to_hash.to_s
end