|
1655 | 1655 | }
|
1656 | 1656 | }
|
1657 | 1657 | },
|
1658 |
| - "revision": "20240522", |
| 1658 | + "revision": "20241024", |
1659 | 1659 | "rootUrl": "https://identitytoolkit.googleapis.com/",
|
1660 | 1660 | "schemas": {
|
1661 | 1661 | "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": {
|
|
2616 | 2616 | "id": "GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig",
|
2617 | 2617 | "properties": {
|
2618 | 2618 | "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.", |
2620 | 2620 | "enum": [
|
2621 | 2621 | "RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED",
|
2622 | 2622 | "OFF",
|
|
2638 | 2638 | },
|
2639 | 2639 | "type": "array"
|
2640 | 2640 | },
|
| 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 | + }, |
2641 | 2657 | "recaptchaKeys": {
|
2642 | 2658 | "description": "The reCAPTCHA keys.",
|
2643 | 2659 | "items": {
|
2644 | 2660 | "$ref": "GoogleCloudIdentitytoolkitAdminV2RecaptchaKey"
|
2645 | 2661 | },
|
2646 | 2662 | "type": "array"
|
2647 | 2663 | },
|
| 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 | + }, |
2648 | 2671 | "useAccountDefender": {
|
2649 | 2672 | "description": "Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.",
|
2650 | 2673 | "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" |
2651 | 2682 | }
|
2652 | 2683 | },
|
2653 | 2684 | "type": "object"
|
|
2703 | 2734 | },
|
2704 | 2735 | "type": "object"
|
2705 | 2736 | },
|
| 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 | + }, |
2706 | 2761 | "GoogleCloudIdentitytoolkitAdminV2RequestLogging": {
|
2707 | 2762 | "description": "Configuration for logging requests made to this project to Stackdriver Logging",
|
2708 | 2763 | "id": "GoogleCloudIdentitytoolkitAdminV2RequestLogging",
|
|
3322 | 3377 | "recaptchaKey": {
|
3323 | 3378 | "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.",
|
3324 | 3379 | "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" |
3325 | 3388 | }
|
3326 | 3389 | },
|
3327 | 3390 | "type": "object"
|
|
3350 | 3413 | "description": "The provider that has reCAPTCHA protection.",
|
3351 | 3414 | "enum": [
|
3352 | 3415 | "RECAPTCHA_PROVIDER_UNSPECIFIED",
|
3353 |
| - "EMAIL_PASSWORD_PROVIDER" |
| 3416 | + "EMAIL_PASSWORD_PROVIDER", |
| 3417 | + "PHONE_PROVIDER" |
3354 | 3418 | ],
|
3355 | 3419 | "enumDescriptions": [
|
3356 | 3420 | "reCAPTCHA provider not specified",
|
3357 |
| - "Email password provider" |
| 3421 | + "Email password provider", |
| 3422 | + "Phone auth provider" |
3358 | 3423 | ],
|
3359 | 3424 | "type": "string"
|
3360 | 3425 | }
|
|
3456 | 3521 | "$ref": "GoogleCloudIdentitytoolkitV2AutoRetrievalInfo",
|
3457 | 3522 | "description": "Android only. Used by Google Play Services to identify the app for auto-retrieval."
|
3458 | 3523 | },
|
| 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 | + }, |
3459 | 3544 | "iosReceipt": {
|
3460 | 3545 | "description": "iOS only. Receipt of successful app token validation with APNS.",
|
3461 | 3546 | "type": "string"
|
|
3476 | 3561 | "description": "Web only. Recaptcha solution.",
|
3477 | 3562 | "type": "string"
|
3478 | 3563 | },
|
| 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 | + }, |
3479 | 3576 | "safetyNetToken": {
|
3480 | 3577 | "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.",
|
3481 | 3578 | "type": "string"
|
|
0 commit comments