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.



3029
3030
3031
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 3029

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) 


3011
3012
3013
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 3011

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:



3016
3017
3018
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 3016

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) 


3022
3023
3024
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 3022

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:



3027
3028
3029
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 3027

def totp_enrollment_info
  @totp_enrollment_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3034
3035
3036
3037
3038
3039
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 3034

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