gcp_recaptchaenterprise_key

ancestors

Type: UNORDERED_LIST_STRING

android_settings

Type: STRUCT
Provider name: androidSettings
Description: Settings for keys that can be used by Android apps.

• allow_all_package_names
  Type: BOOLEAN
  Provider name: allowAllPackageNames
  Description: Optional. If set to true, allowed_package_names are not enforced.
  
• allowed_package_names
  Type: UNORDERED_LIST_STRING
  Provider name: allowedPackageNames
  Description: Optional. Android package names of apps allowed to use the key. Example: ‘com.companyname.appname’
  
• support_non_google_app_store_distribution
  Type: BOOLEAN
  Provider name: supportNonGoogleAppStoreDistribution
  Description: Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
  

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The timestamp corresponding to the creation of this key.

express_settings

Type: STRUCT
Provider name: expressSettings
Description: Settings for keys that can be used by reCAPTCHA Express.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Required. Human-readable display name of this key. Modifiable by user.

ios_settings

Type: STRUCT
Provider name: iosSettings
Description: Settings for keys that can be used by iOS apps.

• allow_all_bundle_ids
  Type: BOOLEAN
  Provider name: allowAllBundleIds
  Description: Optional. If set to true, allowed_bundle_ids are not enforced.
  
• allowed_bundle_ids
  Type: UNORDERED_LIST_STRING
  Provider name: allowedBundleIds
  Description: Optional. iOS bundle ids of apps allowed to use the key. Example: ‘com.companyname.productname.appname’
  
• apple_developer_id
  Type: STRUCT
  Provider name: appleDeveloperId
  Description: Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
  
  • key_id
    Type: STRING
    Provider name: keyId
    Description: Required. The Apple developer key ID (10-character string).
    
  • private_key
    Type: STRING
    Provider name: privateKey
    Description: Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
    
  • team_id
    Type: STRING
    Provider name: teamId
    Description: Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING

testing_options

Type: STRUCT
Provider name: testingOptions
Description: Optional. Options for user acceptance testing.

• testing_challenge
  Type: STRING
  Provider name: testingChallenge
  Description: Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
  Possible values:
  
  • TESTING_CHALLENGE_UNSPECIFIED - Perform the normal risk analysis and return either nocaptcha or a challenge depending on risk and trust factors.
    
  • NOCAPTCHA - Challenge requests for this key always return a nocaptcha, which does not require a solution.
    
  • UNSOLVABLE_CHALLENGE - Challenge requests for this key always return an unsolvable challenge.
    
• testing_score
  Type: FLOAT
  Provider name: testingScore
  Description: Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
  

waf_settings

Type: STRUCT
Provider name: wafSettings
Description: Optional. Settings for WAF

• waf_feature
  Type: STRING
  Provider name: wafFeature
  Description: Required. The WAF feature for which this key is enabled.
  Possible values:
  
  • WAF_FEATURE_UNSPECIFIED - Undefined feature.
    
  • CHALLENGE_PAGE - Redirects suspicious traffic to reCAPTCHA.
    
  • SESSION_TOKEN - Use reCAPTCHA session-tokens to protect the whole user session on the site’s domain.
    
  • ACTION_TOKEN - Use reCAPTCHA action-tokens to protect user actions.
    
  • EXPRESS - Use reCAPTCHA WAF express protection to protect any content other than web pages, like APIs and IoT devices.
    
• waf_service
  Type: STRING
  Provider name: wafService
  Description: Required. The WAF service that uses this key.
  Possible values:
  
  • WAF_SERVICE_UNSPECIFIED - Undefined WAF
    
  • CA - Cloud Armor
    
  • FASTLY - Fastly
    
  • CLOUDFLARE - Cloudflare
    
  • AKAMAI - Akamai
    

web_settings

Type: STRUCT
Provider name: webSettings
Description: Settings for keys that can be used by websites.

• allow_all_domains
  Type: BOOLEAN
  Provider name: allowAllDomains
  Description: Optional. If set to true, it means allowed_domains are not enforced.
  
• allow_amp_traffic
  Type: BOOLEAN
  Provider name: allowAmpTraffic
  Description: Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
  
• allowed_domains
  Type: UNORDERED_LIST_STRING
  Provider name: allowedDomains
  Description: Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: ’example.com’ or ‘subdomain.example.com’
  
• challenge_security_preference
  Type: STRING
  Provider name: challengeSecurityPreference
  Description: Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE.
  Possible values:
  
  • CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED - Default type that indicates this enum hasn’t been specified.
    
  • USABILITY - Key tends to show fewer and easier challenges.
    
  • BALANCE - Key tends to show balanced (in amount and difficulty) challenges.
    
  • SECURITY - Key tends to show more and harder challenges.
    
• integration_type
  Type: STRING
  Provider name: integrationType
  Description: Required. Describes how this key is integrated with the website.
  Possible values:
  
  • INTEGRATION_TYPE_UNSPECIFIED - Default type that indicates this enum hasn’t been specified. This is not a valid IntegrationType, one of the other types must be specified instead.
    
  • SCORE - Only used to produce scores. It doesn't display the ‘I'm not a robot’ checkbox and never shows captcha challenges.
    
  • CHECKBOX - Displays the ‘I'm not a robot’ checkbox and may show captcha challenges after it is checked.
    
  • INVISIBLE - Doesn't display the ‘I'm not a robot’ checkbox, but may show captcha challenges after risk analysis.