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.



2599
2600
2601
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2599

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) 


2581
2582
2583
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2581

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:



2586
2587
2588
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2586

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) 


2592
2593
2594
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2592

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:



2597
2598
2599
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2597

def totp_enrollment_info
  @totp_enrollment_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2604
2605
2606
2607
2608
2609
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2604

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