Skip to main content

recaptcha_enterprise_config

Overview

Namerecaptcha_enterprise_config
TypeResource
Idfirebase.firebaseappcheck.recaptcha_enterprise_config

Fields

NameDatatypeDescription
namestringRequired. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig
siteKeystringThe score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application. Important: This is not the site_secret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
tokenTtlstringSpecifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.

Methods

NameAccessible byRequired ParamsDescription
projects_apps_recaptchaEnterpriseConfig_getSELECTappsId, projectsIdGets the RecaptchaEnterpriseConfig for the specified app.
projects_apps_recaptchaEnterpriseConfig_batchGetEXECprojectsIdAtomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.
projects_apps_recaptchaEnterpriseConfig_patchEXECappsId, projectsIdUpdates the RecaptchaEnterpriseConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA Enterprise tokens for App Check tokens.