Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/identitytoolkit_v1/classes.rb,
lib/google/apis/identitytoolkit_v1/representations.rb,
lib/google/apis/identitytoolkit_v1/representations.rb

Overview

Request message for SendVerificationCode. At least one of (ios_receipt and ios_secret), recaptcha_token, or safety_net_token must be specified to verify the verification code is being sent on behalf of a real app and not an emulator.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.



1756
1757
1758
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1756

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

Instance Attribute Details

#auto_retrieval_info ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1AutoRetrievalInfo

The information required to auto-retrieve an SMS. Corresponds to the JSON property autoRetrievalInfo

Returns:



1695
1696
1697
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1695

def auto_retrieval_info
  @auto_retrieval_info
end

#ios_receipt ⇒ String

Receipt of successful iOS app token validation. At least one of (ios_receipt and ios_secret), recaptcha_token, or safety_net_token must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. This should come from the response of verifyIosClient. If present, the caller should also provide the ios_secret, as well as a bundle ID in the x-ios-bundle-identifier header, which must match the bundle ID from the verifyIosClient request. Corresponds to the JSON property iosReceipt

Returns:

  • (String) 


1706
1707
1708
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1706

def ios_receipt
  @ios_receipt
end

#ios_secret ⇒ String

Secret delivered to iOS app as a push notification. Should be passed with an ios_receipt as well as the x-ios-bundle-identifier header. Corresponds to the JSON property iosSecret

Returns:

  • (String) 


1712
1713
1714
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1712

def ios_secret
  @ios_secret
end

#phone_number ⇒ String

The phone number to send the verification code to in E.164 format. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


1717
1718
1719
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1717

def phone_number
  @phone_number
end

#play_integrity_token ⇒ String

Android only. Used to assert application identity in place of a recaptcha token (and safety_net_token). At least one of (ios_receipt and ios_secret), recaptcha_token, , or play_integrity_token must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. A Play Integrity Token can be generated via the PlayIntegrity API with applying SHA256 to the phone_number field as the nonce. Corresponds to the JSON property playIntegrityToken

Returns:

  • (String) 


1728
1729
1730
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1728

def play_integrity_token
  @play_integrity_token
end

#recaptcha_token ⇒ String

Recaptcha token for app verification. At least one of (ios_receipt and ios_secret), recaptcha_token, or safety_net_token must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge. Corresponds to the JSON property recaptchaToken

Returns:

  • (String) 


1738
1739
1740
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1738

def recaptcha_token
  @recaptcha_token
end

#safety_net_token ⇒ String

Android only. Used to assert application identity in place of a recaptcha token. At least one of (ios_receipt and ios_secret), recaptcha_token, or safety_net_token must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. A SafetyNet Token can be generated via the SafetyNet Android Attestation API, with the Base64 encoding of the phone_number field as the nonce. Corresponds to the JSON property safetyNetToken

Returns:

  • (String) 


1749
1750
1751
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1749

def safety_net_token
  @safety_net_token
end

#tenant_id ⇒ String

Tenant ID of the Identity Platform tenant the user is signing in to. Corresponds to the JSON property tenantId

Returns:

  • (String) 


1754
1755
1756
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1754

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1761

def update!(**args)
  @auto_retrieval_info = args[:auto_retrieval_info] if args.key?(:auto_retrieval_info)
  @ios_receipt = args[:ios_receipt] if args.key?(:ios_receipt)
  @ios_secret = args[:ios_secret] if args.key?(:ios_secret)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @play_integrity_token = args[:play_integrity_token] if args.key?(:play_integrity_token)
  @recaptcha_token = args[:recaptcha_token] if args.key?(:recaptcha_token)
  @safety_net_token = args[:safety_net_token] if args.key?(:safety_net_token)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end