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. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise 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.



1820
1821
1822
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1820

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:



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

def auto_retrieval_info
  @auto_retrieval_info
end

#captcha_response ⇒ String

Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 


1743
1744
1745
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1743

def captcha_response
  @captcha_response
end

#client_type ⇒ String

Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled. Corresponds to the JSON property clientType

Returns:

  • (String) 


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

def client_type
  @client_type
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, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). 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) 


1761
1762
1763
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1761

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) 


1767
1768
1769
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1767

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) 


1772
1773
1774
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1772

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, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). 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) 


1784
1785
1786
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1784

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, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). 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) 


1795
1796
1797
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1795

def recaptcha_token
  @recaptcha_token
end

#recaptcha_version ⇒ String

Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled. Corresponds to the JSON property recaptchaVersion

Returns:

  • (String) 


1801
1802
1803
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1801

def recaptcha_version
  @recaptcha_version
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, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). 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) 


1813
1814
1815
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1813

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) 


1818
1819
1820
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1818

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1825

def update!(**args)
  @auto_retrieval_info = args[:auto_retrieval_info] if args.key?(:auto_retrieval_info)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @client_type = args[:client_type] if args.key?(:client_type)
  @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)
  @recaptcha_version = args[:recaptcha_version] if args.key?(:recaptcha_version)
  @safety_net_token = args[:safety_net_token] if args.key?(:safety_net_token)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end