feat(identitytoolkit): update the API

#### identitytoolkit:v1 The following keys were added: - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.captchaResponse.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.captchaResponse.type - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.clientType.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.clientType.enum - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.clientType.enumDescriptions - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.clientType.type - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.recaptchaVersion.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.recaptchaVersion.enum - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.recaptchaVersion.enumDescriptions - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.recaptchaVersion.type The following keys were changed: - schemas.GoogleCloudIdentitytoolkitV1ResetPasswordRequest.properties.email.description - schemas.GoogleCloudIdentitytoolkitV1ResetPasswordRequest.properties.tenantId.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.iosReceipt.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.playIntegrityToken.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.recaptchaToken.description - schemas.GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest.properties.safetyNetToken.description #### identitytoolkit:v2 The following keys were added: - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.phoneEnforcementState.description - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.phoneEnforcementState.enum - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.phoneEnforcementState.enumDescriptions - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.phoneEnforcementState.type - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.tollFraudManagedRules.description - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.tollFraudManagedRules.items.$ref - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.tollFraudManagedRules.type - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.useSmsBotScore.description - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.useSmsBotScore.type - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.useSmsTollFraudProtection.description - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.useSmsTollFraudProtection.type - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.description - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.id - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.properties.action.description - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.properties.action.enum - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.properties.action.enumDescriptions - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.properties.action.type - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.properties.startScore.description - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.properties.startScore.format - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.properties.startScore.type - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule.type - schemas.GoogleCloudIdentitytoolkitV2RecaptchaConfig.properties.useSmsBotScore.description - schemas.GoogleCloudIdentitytoolkitV2RecaptchaConfig.properties.useSmsBotScore.type - schemas.GoogleCloudIdentitytoolkitV2RecaptchaConfig.properties.useSmsTollFraudProtection.description - schemas.GoogleCloudIdentitytoolkitV2RecaptchaConfig.properties.useSmsTollFraudProtection.type - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.captchaResponse.description - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.captchaResponse.type - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.clientType.description - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.clientType.enum - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.clientType.enumDescriptions - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.clientType.type - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.recaptchaVersion.description - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.recaptchaVersion.enum - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.recaptchaVersion.enumDescriptions - schemas.GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo.properties.recaptchaVersion.type The following keys were changed: - schemas.GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.properties.emailPasswordEnforcementState.description - schemas.GoogleCloudIdentitytoolkitV2RecaptchaEnforcementState.properties.provider.enum - schemas.GoogleCloudIdentitytoolkitV2RecaptchaEnforcementState.properties.provider.enumDescriptions
googleapis · Jan 29, 2025 · ecb87ee · ecb87ee
1 parent dbc043e
commit ecb87ee
Show file tree

Hide file tree

Showing 3 changed files with 191 additions and 13 deletions.
diff --git a/discovery/identitytoolkit-v1.json b/discovery/identitytoolkit-v1.json
@@ -1239,7 +1239,7 @@
       }
     }
   },
-  "revision": "20240424",
+  "revision": "20241205",
   "rootUrl": "https://identitytoolkit.googleapis.com/",
   "schemas": {
     "GoogleCloudIdentitytoolkitV1Argon2Parameters": {
@@ -2361,7 +2361,7 @@
       "id": "GoogleCloudIdentitytoolkitV1ResetPasswordRequest",
       "properties": {
         "email": {
-          "description": "The email of the account to be modified. Specify this and the old password in order to change an account's password without using an out-of-band code.",
+          "description": "Optional. The email of the account to be modified. Specify this and the old password in order to change an account's password without using an out-of-band code.",
           "type": "string"
         },
         "newPassword": {
@@ -2377,7 +2377,7 @@
           "type": "string"
         },
         "tenantId": {
-          "description": "The tenant ID of the Identity Platform tenant the account belongs to.",
+          "description": "Optional. The tenant ID of the Identity Platform tenant the account belongs to.",
           "type": "string"
         }
       },
@@ -2441,15 +2441,35 @@
       "type": "object"
     },
     "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest": {
-      "description": "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.",
+      "description": "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.",
       "id": "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest",
       "properties": {
         "autoRetrievalInfo": {
           "$ref": "GoogleCloudIdentitytoolkitV1AutoRetrievalInfo",
           "description": "Android only. Used by Google Play Services to identify the app for auto-retrieval."
         },
+        "captchaResponse": {
+          "description": "Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.",
+          "type": "string"
+        },
+        "clientType": {
+          "description": "Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.",
+          "enum": [
+            "CLIENT_TYPE_UNSPECIFIED",
+            "CLIENT_TYPE_WEB",
+            "CLIENT_TYPE_ANDROID",
+            "CLIENT_TYPE_IOS"
+          ],
+          "enumDescriptions": [
+            "Client type is not specified.",
+            "Client type is web.",
+            "Client type is android.",
+            "Client type is ios."
+          ],
+          "type": "string"
+        },
         "iosReceipt": {
-          "description": "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.",
+          "description": "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.",
           "type": "string"
         },
         "iosSecret": {
@@ -2461,15 +2481,27 @@
           "type": "string"
         },
         "playIntegrityToken": {
-          "description": "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.",
+          "description": "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](https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.",
           "type": "string"
         },
         "recaptchaToken": {
-          "description": "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.",
+          "description": "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.",
+          "type": "string"
+        },
+        "recaptchaVersion": {
+          "description": "Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.",
+          "enum": [
+            "RECAPTCHA_VERSION_UNSPECIFIED",
+            "RECAPTCHA_ENTERPRISE"
+          ],
+          "enumDescriptions": [
+            "The reCAPTCHA version is not specified.",
+            "The reCAPTCHA enterprise."
+          ],
           "type": "string"
         },
         "safetyNetToken": {
-          "description": "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.",
+          "description": "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](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.",
           "type": "string"
         },
         "tenantId": {

diff --git a/discovery/identitytoolkit-v2.json b/discovery/identitytoolkit-v2.json
@@ -1655,7 +1655,7 @@
       }
     }
   },
-  "revision": "20240522",
+  "revision": "20241024",
   "rootUrl": "https://identitytoolkit.googleapis.com/",
   "schemas": {
     "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": {
@@ -2616,7 +2616,7 @@
       "id": "GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig",
       "properties": {
         "emailPasswordEnforcementState": {
-          "description": "The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all related user flows protected by reCAPTCHA.",
+          "description": "The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.",
           "enum": [
             "RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED",
             "OFF",
@@ -2638,16 +2638,47 @@
           },
           "type": "array"
         },
+        "phoneEnforcementState": {
+          "description": "The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.",
+          "enum": [
+            "RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED",
+            "OFF",
+            "AUDIT",
+            "ENFORCE"
+          ],
+          "enumDescriptions": [
+            "Enforcement state has not been set.",
+            "Unenforced.",
+            "reCAPTCHA assessment is created, result is not used to enforce.",
+            "reCAPTCHA assessment is created, result is used to enforce."
+          ],
+          "type": "string"
+        },
         "recaptchaKeys": {
           "description": "The reCAPTCHA keys.",
           "items": {
             "$ref": "GoogleCloudIdentitytoolkitAdminV2RecaptchaKey"
           },
           "type": "array"
         },
+        "tollFraudManagedRules": {
+          "description": "The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.",
+          "items": {
+            "$ref": "GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule"
+          },
+          "type": "array"
+        },
         "useAccountDefender": {
           "description": "Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.",
           "type": "boolean"
+        },
+        "useSmsBotScore": {
+          "description": "Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.",
+          "type": "boolean"
+        },
+        "useSmsTollFraudProtection": {
+          "description": "Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.",
+          "type": "boolean"
         }
       },
       "type": "object"
@@ -2703,6 +2734,30 @@
       },
       "type": "object"
     },
+    "GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule": {
+      "description": "The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.",
+      "id": "GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule",
+      "properties": {
+        "action": {
+          "description": "The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].",
+          "enum": [
+            "RECAPTCHA_ACTION_UNSPECIFIED",
+            "BLOCK"
+          ],
+          "enumDescriptions": [
+            "The reCAPTCHA action is not specified.",
+            "The reCAPTCHA-protected request will be blocked."
+          ],
+          "type": "string"
+        },
+        "startScore": {
+          "description": "The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.",
+          "format": "float",
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudIdentitytoolkitAdminV2RequestLogging": {
       "description": "Configuration for logging requests made to this project to Stackdriver Logging",
       "id": "GoogleCloudIdentitytoolkitAdminV2RequestLogging",
@@ -3322,6 +3377,14 @@
         "recaptchaKey": {
           "description": "The reCAPTCHA Enterprise key resource name, e.g. \"projects/{project}/keys/{key}\". This will only be returned when the reCAPTCHA enforcement state is AUDIT or ENFORCE on at least one of the reCAPTCHA providers.",
           "type": "string"
+        },
+        "useSmsBotScore": {
+          "description": "Whether to use the rCE bot score for reCAPTCHA phone provider.",
+          "type": "boolean"
+        },
+        "useSmsTollFraudProtection": {
+          "description": "Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider.",
+          "type": "boolean"
         }
       },
       "type": "object"
@@ -3350,11 +3413,13 @@
           "description": "The provider that has reCAPTCHA protection.",
           "enum": [
             "RECAPTCHA_PROVIDER_UNSPECIFIED",
-            "EMAIL_PASSWORD_PROVIDER"
+            "EMAIL_PASSWORD_PROVIDER",
+            "PHONE_PROVIDER"
           ],
           "enumDescriptions": [
             "reCAPTCHA provider not specified",
-            "Email password provider"
+            "Email password provider",
+            "Phone auth provider"
           ],
           "type": "string"
         }
@@ -3456,6 +3521,26 @@
           "$ref": "GoogleCloudIdentitytoolkitV2AutoRetrievalInfo",
           "description": "Android only. Used by Google Play Services to identify the app for auto-retrieval."
         },
+        "captchaResponse": {
+          "description": "The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.",
+          "type": "string"
+        },
+        "clientType": {
+          "description": "The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.",
+          "enum": [
+            "CLIENT_TYPE_UNSPECIFIED",
+            "CLIENT_TYPE_WEB",
+            "CLIENT_TYPE_ANDROID",
+            "CLIENT_TYPE_IOS"
+          ],
+          "enumDescriptions": [
+            "Client type is not specified.",
+            "Client type is web.",
+            "Client type is android.",
+            "Client type is ios."
+          ],
+          "type": "string"
+        },
         "iosReceipt": {
           "description": "iOS only. Receipt of successful app token validation with APNS.",
           "type": "string"
@@ -3476,6 +3561,18 @@
           "description": "Web only. Recaptcha solution.",
           "type": "string"
         },
+        "recaptchaVersion": {
+          "description": "The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.",
+          "enum": [
+            "RECAPTCHA_VERSION_UNSPECIFIED",
+            "RECAPTCHA_ENTERPRISE"
+          ],
+          "enumDescriptions": [
+            "The reCAPTCHA version is not specified.",
+            "The reCAPTCHA enterprise."
+          ],
+          "type": "string"
+        },
         "safetyNetToken": {
           "description": "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.",
           "type": "string"