Skip to main content

recaptcha_v3_config

Overview

Namerecaptcha_v3_config
TypeResource
Idfirebase.firebaseappcheck.recaptcha_v3_config

Fields

NameDatatypeDescription
namestringRequired. The relative resource name of the reCAPTCHA v3 configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaV3Config
siteSecretstringRequired. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response.
siteSecretSetbooleanOutput only. Whether the site_secret field was previously set. Since we will never return the site_secret field, this field is the only way to find out whether it was previously set.
tokenTtlstringSpecifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive.

Methods

NameAccessible byRequired ParamsDescription
projects_apps_recaptchaV3Config_getSELECTappsId, projectsIdGets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response.
projects_apps_recaptchaV3Config_batchGetEXECprojectsIdAtomically gets the RecaptchaV3Configs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.
projects_apps_recaptchaV3Config_patchEXECappsId, projectsIdUpdates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response.