Skip to content

Commit ecb87ee

Browse files
yoshi-automationsofisl
authored andcommitted
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
1 parent dbc043e commit ecb87ee

File tree

3 files changed

+191
-13
lines changed

3 files changed

+191
-13
lines changed

‎discovery/identitytoolkit-v1.json

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,7 +1239,7 @@
12391239
}
12401240
}
12411241
},
1242-
"revision": "20240424",
1242+
"revision": "20241205",
12431243
"rootUrl": "https://identitytoolkit.googleapis.com/",
12441244
"schemas": {
12451245
"GoogleCloudIdentitytoolkitV1Argon2Parameters": {
@@ -2361,7 +2361,7 @@
23612361
"id": "GoogleCloudIdentitytoolkitV1ResetPasswordRequest",
23622362
"properties": {
23632363
"email": {
2364-
"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.",
2364+
"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.",
23652365
"type": "string"
23662366
},
23672367
"newPassword": {
@@ -2377,7 +2377,7 @@
23772377
"type": "string"
23782378
},
23792379
"tenantId": {
2380-
"description": "The tenant ID of the Identity Platform tenant the account belongs to.",
2380+
"description": "Optional. The tenant ID of the Identity Platform tenant the account belongs to.",
23812381
"type": "string"
23822382
}
23832383
},
@@ -2441,15 +2441,35 @@
24412441
"type": "object"
24422442
},
24432443
"GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest": {
2444-
"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.",
2444+
"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.",
24452445
"id": "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest",
24462446
"properties": {
24472447
"autoRetrievalInfo": {
24482448
"$ref": "GoogleCloudIdentitytoolkitV1AutoRetrievalInfo",
24492449
"description": "Android only. Used by Google Play Services to identify the app for auto-retrieval."
24502450
},
2451+
"captchaResponse": {
2452+
"description": "Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.",
2453+
"type": "string"
2454+
},
2455+
"clientType": {
2456+
"description": "Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.",
2457+
"enum": [
2458+
"CLIENT_TYPE_UNSPECIFIED",
2459+
"CLIENT_TYPE_WEB",
2460+
"CLIENT_TYPE_ANDROID",
2461+
"CLIENT_TYPE_IOS"
2462+
],
2463+
"enumDescriptions": [
2464+
"Client type is not specified.",
2465+
"Client type is web.",
2466+
"Client type is android.",
2467+
"Client type is ios."
2468+
],
2469+
"type": "string"
2470+
},
24512471
"iosReceipt": {
2452-
"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.",
2472+
"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.",
24532473
"type": "string"
24542474
},
24552475
"iosSecret": {
@@ -2461,15 +2481,27 @@
24612481
"type": "string"
24622482
},
24632483
"playIntegrityToken": {
2464-
"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.",
2484+
"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.",
24652485
"type": "string"
24662486
},
24672487
"recaptchaToken": {
2468-
"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.",
2488+
"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.",
2489+
"type": "string"
2490+
},
2491+
"recaptchaVersion": {
2492+
"description": "Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.",
2493+
"enum": [
2494+
"RECAPTCHA_VERSION_UNSPECIFIED",
2495+
"RECAPTCHA_ENTERPRISE"
2496+
],
2497+
"enumDescriptions": [
2498+
"The reCAPTCHA version is not specified.",
2499+
"The reCAPTCHA enterprise."
2500+
],
24692501
"type": "string"
24702502
},
24712503
"safetyNetToken": {
2472-
"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.",
2504+
"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.",
24732505
"type": "string"
24742506
},
24752507
"tenantId": {

‎discovery/identitytoolkit-v2.json

Lines changed: 101 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1655,7 +1655,7 @@
16551655
}
16561656
}
16571657
},
1658-
"revision": "20240522",
1658+
"revision": "20241024",
16591659
"rootUrl": "https://identitytoolkit.googleapis.com/",
16601660
"schemas": {
16611661
"GoogleCloudIdentitytoolkitAdminV2AllowByDefault": {
@@ -2616,7 +2616,7 @@
26162616
"id": "GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig",
26172617
"properties": {
26182618
"emailPasswordEnforcementState": {
2619-
"description": "The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all related user flows protected by reCAPTCHA.",
2619+
"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.",
26202620
"enum": [
26212621
"RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED",
26222622
"OFF",
@@ -2638,16 +2638,47 @@
26382638
},
26392639
"type": "array"
26402640
},
2641+
"phoneEnforcementState": {
2642+
"description": "The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.",
2643+
"enum": [
2644+
"RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED",
2645+
"OFF",
2646+
"AUDIT",
2647+
"ENFORCE"
2648+
],
2649+
"enumDescriptions": [
2650+
"Enforcement state has not been set.",
2651+
"Unenforced.",
2652+
"reCAPTCHA assessment is created, result is not used to enforce.",
2653+
"reCAPTCHA assessment is created, result is used to enforce."
2654+
],
2655+
"type": "string"
2656+
},
26412657
"recaptchaKeys": {
26422658
"description": "The reCAPTCHA keys.",
26432659
"items": {
26442660
"$ref": "GoogleCloudIdentitytoolkitAdminV2RecaptchaKey"
26452661
},
26462662
"type": "array"
26472663
},
2664+
"tollFraudManagedRules": {
2665+
"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.",
2666+
"items": {
2667+
"$ref": "GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule"
2668+
},
2669+
"type": "array"
2670+
},
26482671
"useAccountDefender": {
26492672
"description": "Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.",
26502673
"type": "boolean"
2674+
},
2675+
"useSmsBotScore": {
2676+
"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.",
2677+
"type": "boolean"
2678+
},
2679+
"useSmsTollFraudProtection": {
2680+
"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.",
2681+
"type": "boolean"
26512682
}
26522683
},
26532684
"type": "object"
@@ -2703,6 +2734,30 @@
27032734
},
27042735
"type": "object"
27052736
},
2737+
"GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule": {
2738+
"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.",
2739+
"id": "GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule",
2740+
"properties": {
2741+
"action": {
2742+
"description": "The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].",
2743+
"enum": [
2744+
"RECAPTCHA_ACTION_UNSPECIFIED",
2745+
"BLOCK"
2746+
],
2747+
"enumDescriptions": [
2748+
"The reCAPTCHA action is not specified.",
2749+
"The reCAPTCHA-protected request will be blocked."
2750+
],
2751+
"type": "string"
2752+
},
2753+
"startScore": {
2754+
"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.",
2755+
"format": "float",
2756+
"type": "number"
2757+
}
2758+
},
2759+
"type": "object"
2760+
},
27062761
"GoogleCloudIdentitytoolkitAdminV2RequestLogging": {
27072762
"description": "Configuration for logging requests made to this project to Stackdriver Logging",
27082763
"id": "GoogleCloudIdentitytoolkitAdminV2RequestLogging",
@@ -3322,6 +3377,14 @@
33223377
"recaptchaKey": {
33233378
"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.",
33243379
"type": "string"
3380+
},
3381+
"useSmsBotScore": {
3382+
"description": "Whether to use the rCE bot score for reCAPTCHA phone provider.",
3383+
"type": "boolean"
3384+
},
3385+
"useSmsTollFraudProtection": {
3386+
"description": "Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider.",
3387+
"type": "boolean"
33253388
}
33263389
},
33273390
"type": "object"
@@ -3350,11 +3413,13 @@
33503413
"description": "The provider that has reCAPTCHA protection.",
33513414
"enum": [
33523415
"RECAPTCHA_PROVIDER_UNSPECIFIED",
3353-
"EMAIL_PASSWORD_PROVIDER"
3416+
"EMAIL_PASSWORD_PROVIDER",
3417+
"PHONE_PROVIDER"
33543418
],
33553419
"enumDescriptions": [
33563420
"reCAPTCHA provider not specified",
3357-
"Email password provider"
3421+
"Email password provider",
3422+
"Phone auth provider"
33583423
],
33593424
"type": "string"
33603425
}
@@ -3456,6 +3521,26 @@
34563521
"$ref": "GoogleCloudIdentitytoolkitV2AutoRetrievalInfo",
34573522
"description": "Android only. Used by Google Play Services to identify the app for auto-retrieval."
34583523
},
3524+
"captchaResponse": {
3525+
"description": "The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.",
3526+
"type": "string"
3527+
},
3528+
"clientType": {
3529+
"description": "The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.",
3530+
"enum": [
3531+
"CLIENT_TYPE_UNSPECIFIED",
3532+
"CLIENT_TYPE_WEB",
3533+
"CLIENT_TYPE_ANDROID",
3534+
"CLIENT_TYPE_IOS"
3535+
],
3536+
"enumDescriptions": [
3537+
"Client type is not specified.",
3538+
"Client type is web.",
3539+
"Client type is android.",
3540+
"Client type is ios."
3541+
],
3542+
"type": "string"
3543+
},
34593544
"iosReceipt": {
34603545
"description": "iOS only. Receipt of successful app token validation with APNS.",
34613546
"type": "string"
@@ -3476,6 +3561,18 @@
34763561
"description": "Web only. Recaptcha solution.",
34773562
"type": "string"
34783563
},
3564+
"recaptchaVersion": {
3565+
"description": "The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.",
3566+
"enum": [
3567+
"RECAPTCHA_VERSION_UNSPECIFIED",
3568+
"RECAPTCHA_ENTERPRISE"
3569+
],
3570+
"enumDescriptions": [
3571+
"The reCAPTCHA version is not specified.",
3572+
"The reCAPTCHA enterprise."
3573+
],
3574+
"type": "string"
3575+
},
34793576
"safetyNetToken": {
34803577
"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.",
34813578
"type": "string"

0 commit comments

Comments
 (0)