REST Resource: projects.apps.recaptchaConfig

Resource: RecaptchaConfig

An app's reCAPTCHA v3 configuration object. This configuration is used by apps.exchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned AppCheckToken, such as its ttl.

JSON representation 
{
  "tokenTtl": string,
  "name": string,
  "siteSecret": string,
  "siteSecretSet": boolean
}
Fields
tokenTtl

string (Duration format)

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.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
name

string

Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format:

projects/{project_number}/apps/{app_id}/recaptchaConfig
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 siteSecret field was previously set. Since we will never return the siteSecret field, this field is the only way to find out whether it was previously set.

Methods

batchGet
(deprecated)

 Atomically gets the RecaptchaConfigs for the specified list of apps.

get
(deprecated)

 Gets the RecaptchaConfig for the specified app.

patch
(deprecated)

 Updates the RecaptchaConfig for the specified app.