recaptcha_v3_config
Overview
Name | recaptcha_v3_config |
Type | Resource |
Id | firebase.firebaseappcheck.recaptcha_v3_config |
Fields
Name | Datatype | Description |
---|---|---|
name | string | Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaV3Config |
siteSecret | string | Required. 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. |
siteSecretSet | boolean | Output 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. |
tokenTtl | string | Specifies 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
Name | Accessible by | Required Params | Description |
---|---|---|---|
projects_apps_recaptchaV3Config_get | SELECT | appsId, projectsId | Gets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response. |
projects_apps_recaptchaV3Config_batchGet | EXEC | projectsId | Atomically 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_patch | EXEC | appsId, projectsId | Updates 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. |