recaptcha_enterprise_config

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

Overview

Name	recaptcha_enterprise_config
Type	Resource
Id	firebase.appcheck.recaptcha_enterprise_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 Enterprise configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig
siteKey	string	The 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.
tokenTtl	string (google-duration)	Specifies 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.

batch_get

Successful response

Name	Datatype	Description
configs	array	RecaptchaEnterpriseConfigs retrieved.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, appsId		Gets the RecaptchaEnterpriseConfig for the specified app.
batch_get	select	projectsId	names	Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.
patch	update	projectsId, appsId	updateMask	Updates 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.

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 RecaptchaEnterpriseConfig for the specified app.

SELECT
name,
siteKey,
tokenTtl
FROM firebase.appcheck.recaptcha_enterprise_config
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required;

batch_get

Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

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

UPDATE examples

patch

Updates 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.

UPDATE firebase.appcheck.recaptcha_enterprise_config
SET 
data__name = '{{ name }}',
data__tokenTtl = '{{ tokenTtl }}',
data__siteKey = '{{ siteKey }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND appsId = '{{ appsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
siteKey,
tokenTtl;