Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1MfaEnrollment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/identitytoolkit_v1/classes.rb,
lib/google/apis/identitytoolkit_v1/representations.rb,
lib/google/apis/identitytoolkit_v1/representations.rb

Overview

Information on which multi-factor authentication (MFA) providers are enabled for an account.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1MfaEnrollment

Returns a new instance of GoogleCloudIdentitytoolkitV1MfaEnrollment.



1364
1365
1366
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1364

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#display_name ⇒ String

Display name for this mfa option e.g. "corp cell phone". Corresponds to the JSON property displayName

Returns:

  • (String) 


1330
1331
1332
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1330

def display_name
  @display_name
end

#email_info ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1EmailInfo

Information about email MFA. Corresponds to the JSON property emailInfo

Returns:



1335
1336
1337
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1335

def email_info
  @email_info
end

#enrolled_at ⇒ String

Timestamp when the account enrolled this second factor. Corresponds to the JSON property enrolledAt

Returns:

  • (String) 


1340
1341
1342
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1340

def enrolled_at
  @enrolled_at
end

#mfa_enrollment_id ⇒ String

ID of this MFA option. Corresponds to the JSON property mfaEnrollmentId

Returns:

  • (String) 


1345
1346
1347
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1345

def mfa_enrollment_id
  @mfa_enrollment_id
end

#phone_info ⇒ String

Normally this will show the phone number associated with this enrollment. In some situations, such as after a first factor sign in, it will only show the obfuscated version of the associated phone number. Corresponds to the JSON property phoneInfo

Returns:

  • (String) 


1352
1353
1354
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1352

def phone_info
  @phone_info
end

#totp_info ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1TotpInfo

Information about TOTP MFA. Corresponds to the JSON property totpInfo

Returns:



1357
1358
1359
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1357

def totp_info
  @totp_info
end

#unobfuscated_phone_info ⇒ String

Output only. Unobfuscated phone_info. Corresponds to the JSON property unobfuscatedPhoneInfo

Returns:

  • (String) 


1362
1363
1364
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1362

def unobfuscated_phone_info
  @unobfuscated_phone_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1369

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email_info = args[:email_info] if args.key?(:email_info)
  @enrolled_at = args[:enrolled_at] if args.key?(:enrolled_at)
  @mfa_enrollment_id = args[:mfa_enrollment_id] if args.key?(:mfa_enrollment_id)
  @phone_info = args[:phone_info] if args.key?(:phone_info)
  @totp_info = args[:totp_info] if args.key?(:totp_info)
  @unobfuscated_phone_info = args[:unobfuscated_phone_info] if args.key?(:unobfuscated_phone_info)
end