REST Resource: projects.apps.recaptchaEnterpriseConfig
Stay organized with collections
Save and categorize content based on your preferences.
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 AppCheckTokenttl.
| JSON representation |
{
"name": string,
"tokenTtl": string,
"siteKey": string
} |
| 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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-05 UTC.
[null,null,["Last updated 2024-04-05 UTC."],[],[],null,["# REST Resource: projects.apps.recaptchaEnterpriseConfig\n\nResource: RecaptchaEnterpriseConfig\n-----------------------------------\n\nAn app's reCAPTCHA Enterprise configuration object. This configuration is used by [ExchangeRecaptchaEnterpriseToken](/docs/reference/appcheck/rest/v1/projects.apps/exchangeRecaptchaEnterpriseToken#google.firebase.appcheck.v1.TokenExchangeService.ExchangeRecaptchaEnterpriseToken) to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned [`AppCheckToken`](/docs/reference/appcheck/rest/v1/AppCheckToken), such as its [ttl](/docs/reference/appcheck/rest/v1/AppCheckToken#FIELDS.ttl).\n\n| JSON representation |\n|-------------------------------------------------------------------|\n| ``` { \"name\": string, \"tokenTtl\": string, \"siteKey\": string } ``` |\n\n| Fields ||\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig |\n| `tokenTtl` | `string (`[Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `siteKey` | `string` The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `siteSecret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [batchGet](/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig/batchGet) | Atomically gets the [RecaptchaEnterpriseConfig](/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig#RecaptchaEnterpriseConfig)s for the specified list of apps. |\n| ### [get](/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig/get) | Gets the [RecaptchaEnterpriseConfig](/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig#RecaptchaEnterpriseConfig) for the specified app. |\n| ### [patch](/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig/patch) | Updates the [RecaptchaEnterpriseConfig](/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig#RecaptchaEnterpriseConfig) for the specified app. |"]]
