Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest

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

Overview

Sends MFA enrollment verification SMS for a user.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest

Returns a new instance of GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest.



2633
2634
2635
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2633

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

Instance Attribute Details

#id_token ⇒ String

Required. User's ID token. Corresponds to the JSON property idToken

Returns:

  • (String) 


2615
2616
2617
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2615

def id_token
  @id_token
end

#phone_enrollment_info ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo

App Verification info for a StartMfa request. Corresponds to the JSON property phoneEnrollmentInfo

Returns:



2620
2621
2622
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2620

def phone_enrollment_info
  @phone_enrollment_info
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


2626
2627
2628
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2626

def tenant_id
  @tenant_id
end

#totp_enrollment_info ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaTotpEnrollmentRequestInfo

Mfa request info specific to TOTP auth for StartMfa. Corresponds to the JSON property totpEnrollmentInfo

Returns:



2631
2632
2633
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2631

def totp_enrollment_info
  @totp_enrollment_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2638
2639
2640
2641
2642
2643
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2638

def update!(**args)
  @id_token = args[:id_token] if args.key?(:id_token)
  @phone_enrollment_info = args[:phone_enrollment_info] if args.key?(:phone_enrollment_info)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @totp_enrollment_info = args[:totp_enrollment_info] if args.key?(:totp_enrollment_info)
end