Skip to content

Commit d7f6f8b

Browse files
feat(identitytoolkit): update the api
#### identitytoolkit:v2 The following keys were added: - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.useSmsBotScore.type (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.useSmsTollFraudProtection.type (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2RecaptchaConfig.properties.useSmsBotScore.type (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitV2RecaptchaConfig.properties.useSmsTollFraudProtection.type (Total Keys: 1)
1 parent d29235d commit d7f6f8b

8 files changed

+103
-67
lines changed

docs/dyn/identitytoolkit_v1.accounts.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -445,19 +445,19 @@ <h3>Method Details</h3>
445445
body: object, The request body.
446446
The object takes the form of:
447447

448-
{ # 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.
448+
{ # Request message for SendVerificationCode. &#x27;captcha_response&#x27; 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.
449449
&quot;autoRetrievalInfo&quot;: { # The information required to auto-retrieve an SMS. # Android only. Used by Google Play Services to identify the app for auto-retrieval.
450450
&quot;appSignatureHash&quot;: &quot;A String&quot;, # The Android app&#x27;s signature hash for Google Play Service&#x27;s SMS Retriever API.
451451
},
452452
&quot;captchaResponse&quot;: &quot;A String&quot;, # Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.
453453
&quot;clientType&quot;: &quot;A String&quot;, # Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.
454-
&quot;iosReceipt&quot;: &quot;A String&quot;, # 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.
454+
&quot;iosReceipt&quot;: &quot;A String&quot;, # 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 &#x27;captcha_response&#x27; 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.
455455
&quot;iosSecret&quot;: &quot;A String&quot;, # 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.
456456
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number to send the verification code to in E.164 format.
457-
&quot;playIntegrityToken&quot;: &quot;A String&quot;, # 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](https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.
458-
&quot;recaptchaToken&quot;: &quot;A String&quot;, # 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.
459-
&quot;recaptchaVersion&quot;: &quot;A String&quot;, # Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response.
460-
&quot;safetyNetToken&quot;: &quot;A String&quot;, # 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](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.
457+
&quot;playIntegrityToken&quot;: &quot;A String&quot;, # 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 &#x27;captcha_response&#x27; is not used (reCAPTCHA enterprise is not enabled). A Play Integrity Token can be generated via the [PlayIntegrity API](https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.
458+
&quot;recaptchaToken&quot;: &quot;A String&quot;, # 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 &#x27;captcha_response&#x27; 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.
459+
&quot;recaptchaVersion&quot;: &quot;A String&quot;, # Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.
460+
&quot;safetyNetToken&quot;: &quot;A String&quot;, # 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 &#x27;captcha_response&#x27; is not used (reCAPTCHA enterprise is not enabled). A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.
461461
&quot;tenantId&quot;: &quot;A String&quot;, # Tenant ID of the Identity Platform tenant the user is signing in to.
462462
}
463463

docs/dyn/identitytoolkit_v2.accounts.mfaEnrollment.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ <h3>Method Details</h3>
158158
&quot;phoneNumber&quot;: &quot;A String&quot;, # Required for enrollment. Phone number to be enrolled as MFA.
159159
&quot;playIntegrityToken&quot;: &quot;A String&quot;, # Android only. Used to assert application identity in place of a recaptcha token (or safety net token). A Play Integrity Token can be generated via the [PlayIntegrity API] (https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.
160160
&quot;recaptchaToken&quot;: &quot;A String&quot;, # Web only. Recaptcha solution.
161-
&quot;recaptchaVersion&quot;: &quot;A String&quot;, # The reCAPTCHA version of the reCAPTCHA token in the captcha_response.
161+
&quot;recaptchaVersion&quot;: &quot;A String&quot;, # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.
162162
&quot;safetyNetToken&quot;: &quot;A String&quot;, # Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.
163163
},
164164
&quot;tenantId&quot;: &quot;A String&quot;, # 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.

docs/dyn/identitytoolkit_v2.accounts.mfaSignIn.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ <h3>Method Details</h3>
153153
&quot;phoneNumber&quot;: &quot;A String&quot;, # Required for enrollment. Phone number to be enrolled as MFA.
154154
&quot;playIntegrityToken&quot;: &quot;A String&quot;, # Android only. Used to assert application identity in place of a recaptcha token (or safety net token). A Play Integrity Token can be generated via the [PlayIntegrity API] (https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.
155155
&quot;recaptchaToken&quot;: &quot;A String&quot;, # Web only. Recaptcha solution.
156-
&quot;recaptchaVersion&quot;: &quot;A String&quot;, # The reCAPTCHA version of the reCAPTCHA token in the captcha_response.
156+
&quot;recaptchaVersion&quot;: &quot;A String&quot;, # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.
157157
&quot;safetyNetToken&quot;: &quot;A String&quot;, # Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.
158158
},
159159
&quot;tenantId&quot;: &quot;A String&quot;, # The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.

0 commit comments

Comments
 (0)