Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaSignInRequest

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

Starts multi-factor sign-in by sending the multi-factor auth challenge.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV2StartMfaSignInRequest

Returns a new instance of GoogleCloudIdentitytoolkitV2StartMfaSignInRequest.



2742
2743
2744
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2742

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

Instance Attribute Details

#mfa_enrollment_id ⇒ String

Required. MFA enrollment id from the user's list of current MFA enrollments. Corresponds to the JSON property mfaEnrollmentId

Returns:

  • (String) 


2724
2725
2726
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2724

def mfa_enrollment_id
  @mfa_enrollment_id
end

#mfa_pending_credential ⇒ String

Required. Pending credential from first factor sign-in. Corresponds to the JSON property mfaPendingCredential

Returns:

  • (String) 


2729
2730
2731
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2729

def mfa_pending_credential
  @mfa_pending_credential
end

#phone_sign_in_info ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo

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

Returns:



2734
2735
2736
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2734

def 
  @phone_sign_in_info
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


2740
2741
2742
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2740

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2747
2748
2749
2750
2751
2752
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2747

def update!(**args)
  @mfa_enrollment_id = args[:mfa_enrollment_id] if args.key?(:mfa_enrollment_id)
  @mfa_pending_credential = args[:mfa_pending_credential] if args.key?(:mfa_pending_credential)
  @phone_sign_in_info = args[:phone_sign_in_info] if args.key?(:phone_sign_in_info)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end