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.



2680
2681
2682
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2680

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) 


2662
2663
2664
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2662

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:



2667
2668
2669
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2667

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) 


2673
2674
2675
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2673

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:



2678
2679
2680
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2678

def totp_enrollment_info
  @totp_enrollment_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2685
2686
2687
2688
2689
2690
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2685

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