Class: OCI::Identity::Models::MfaTotpDevice

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/mfa_totp_device.rb

Overview

Users can enable multi-factor authentication (MFA) for their own user accounts. After MFA is enabled, the user is prompted for a time-based one-time password (TOTP) to authenticate before they can sign in to the Console. To enable multi-factor authentication, the user must register a mobile device with a TOTP authenticator app installed. The registration process creates the MfaTotpDevice object. The registration process requires interaction with the Console and cannot be completed programmatically. For more information, see Managing Multi-Factor Authentication.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MfaTotpDevice

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id property

  • :seed (String)

    The value to assign to the #seed property

  • :user_id (String)

    The value to assign to the #user_id property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_expires (DateTime)

    The value to assign to the #time_expires property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :inactive_status (Integer)

    The value to assign to the #inactive_status property

  • :is_activated (BOOLEAN)

    The value to assign to the #is_activated property



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 120

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

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

  self.user_id = attributes[:'userId'] if attributes[:'userId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_expires = attributes[:'timeExpires'] if attributes[:'timeExpires']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.inactive_status = attributes[:'inactiveStatus'] if attributes[:'inactiveStatus']

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

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

  self.is_activated = attributes[:'isActivated'] unless attributes[:'isActivated'].nil?

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

  self.is_activated = attributes[:'is_activated'] unless attributes[:'is_activated'].nil?
end

Instance Attribute Details

#idString

[Required] The OCID of the MFA TOTP device.

Returns:

  • (String)


28
29
30
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 28

def id
  @id
end

#inactive_statusInteger

The detailed status of INACTIVE lifecycleState. Allowed values are: - 1 - SUSPENDED - 2 - DISABLED - 4 - BLOCKED - 8 - LOCKED

Returns:

  • (Integer)


68
69
70
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 68

def inactive_status
  @inactive_status
end

#is_activatedBOOLEAN

[Required] Flag to indicate if the MFA TOTP device has been activated.

Returns:

  • (BOOLEAN)


72
73
74
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 72

def is_activated
  @is_activated
end

#lifecycle_stateString

[Required] The MFA TOTP device's current state. After creating the MFA TOTP device, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

  • (String)


58
59
60
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#seedString

[Required] The seed for the MFA TOTP device (Base32 encoded).

Returns:

  • (String)


33
34
35
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 33

def seed
  @seed
end

#time_createdDateTime

[Required] Date and time the MfaTotpDevice object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


44
45
46
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 44

def time_created
  @time_created
end

#time_expiresDateTime

Date and time when this MFA TOTP device will expire, in the format defined by RFC3339. Null if it never expires.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


52
53
54
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 52

def time_expires
  @time_expires
end

#user_idString

[Required] The OCID of the user the MFA TOTP device belongs to.

Returns:

  • (String)


37
38
39
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 37

def user_id
  @user_id
end

Class Method Details

.attribute_mapObject

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 75

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'seed': :'seed',
    'user_id': :'userId',
    'time_created': :'timeCreated',
    'time_expires': :'timeExpires',
    'lifecycle_state': :'lifecycleState',
    'inactive_status': :'inactiveStatus',
    'is_activated': :'isActivated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'seed': :'String',
    'user_id': :'String',
    'time_created': :'DateTime',
    'time_expires': :'DateTime',
    'lifecycle_state': :'String',
    'inactive_status': :'Integer',
    'is_activated': :'BOOLEAN'
    # 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



187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 187

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

  self.class == other.class &&
    id == other.id &&
    seed == other.seed &&
    user_id == other.user_id &&
    time_created == other.time_created &&
    time_expires == other.time_expires &&
    lifecycle_state == other.lifecycle_state &&
    inactive_status == other.inactive_status &&
    is_activated == other.is_activated
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 224

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


204
205
206
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 204

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



213
214
215
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 213

def hash
  [id, seed, user_id, time_created, time_expires, lifecycle_state, inactive_status, is_activated].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
266
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 257

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



251
252
253
# File 'lib/oci/identity/models/mfa_totp_device.rb', line 251

def to_s
  to_hash.to_s
end