recaptcha_v3_config

Creates, updates, deletes, gets or lists a recaptcha_v3_config resource.

Overview

Name	recaptcha_v3_config
Type	Resource
Id	firebase.appcheck.recaptcha_v3_config

Fields

The following fields are returned by SELECT queries:

get

Successful response

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 (google-duration)	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.

batch_get

Successful response

Name	Datatype	Description
configs	array	RecaptchaV3Configs retrieved.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, appsId		Gets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response.
batch_get	select	projectsId	names	Atomically gets the RecaptchaV3Configs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.
patch	update	projectsId, appsId	updateMask	Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appsId	string
projectsId	string
names	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response.

SELECT
name,
siteSecret,
siteSecretSet,
tokenTtl
FROM firebase.appcheck.recaptcha_v3_config
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required;

batch_get

Atomically gets the RecaptchaV3Configs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.

SELECT
configs
FROM firebase.appcheck.recaptcha_v3_config
WHERE projectsId = '{{ projectsId }}' -- required
AND names = '{{ names }}';

UPDATE examples

patch

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response.

UPDATE firebase.appcheck.recaptcha_v3_config
SET 
data__tokenTtl = '{{ tokenTtl }}',
data__name = '{{ name }}',
data__siteSecret = '{{ siteSecret }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND appsId = '{{ appsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
siteSecret,
siteSecretSet,
tokenTtl;