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.



2123
2124
2125
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2123

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) 


2105
2106
2107
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2105

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) 


2110
2111
2112
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2110

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:



2115
2116
2117
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2115

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) 


2121
2122
2123
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2121

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2128
2129
2130
2131
2132
2133
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2128

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