REST Resource: projects.apps.recaptchaEnterpriseConfig

Resource: RecaptchaEnterpriseConfig

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

JSON representation 
{
  "name": string,
  "tokenTtl": string,
  "siteKey": string,
  "riskAnalysis": {
    object (RiskAnalysis)
  }
}
Fields
name

string

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

projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig
tokenTtl

string (Duration format)

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.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
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 siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
riskAnalysis

object (RiskAnalysis)

Specifies risk tolerance and requirements for your application.

These settings correspond to requirements on the riskAnalysis tuple in the assessment obtained from reCAPTCHA Enterprise.

The default values for these settings work for most apps, and are recommended.

RiskAnalysis

A settings object specifying risk tolerance and requirements for your application.

These settings correspond to requirements on the riskAnalysis tuple in the assessment obtained from reCAPTCHA Enterprise.

The default values for these settings work for most apps, and are recommended.

JSON representation 
{
  "minValidScore": number
}
Fields
minValidScore

number

Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected.

The value must be between 0.0 and 1.0. The default value is 0.5.

Methods

batchGet

 Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

get

 Gets the RecaptchaEnterpriseConfig for the specified app.

patch

 Updates the RecaptchaEnterpriseConfig for the specified app.