REST Resource: projects.apps.recaptchaV3Config
Stay organized with collections
Save and categorize content based on your preferences.
Resource: RecaptchaV3Config
An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned AppCheckTokenttl.
| 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}/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 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.
|
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.recaptchaV3Config\n\nResource: RecaptchaV3Config\n---------------------------\n\nAn app's reCAPTCHA v3 configuration object. This configuration is used by [ExchangeRecaptchaV3Token](/docs/reference/appcheck/rest/v1beta/projects.apps/exchangeRecaptchaV3Token#google.firebase.appcheck.v1beta.TokenExchangeService.ExchangeRecaptchaV3Token) to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned [`AppCheckToken`](/docs/reference/appcheck/rest/v1beta/AppCheckToken), such as its [ttl](/docs/reference/appcheck/rest/v1beta/AppCheckToken#FIELDS.ttl).\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------|\n| ``` { \"tokenTtl\": string, \"name\": string, \"siteSecret\": string, \"siteSecretSet\": boolean } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\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 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\"`. |\n| `name` | `string` Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaV3Config |\n| `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. |\n| `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. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [batchGet](/docs/reference/appcheck/rest/v1beta/projects.apps.recaptchaV3Config/batchGet) | Atomically gets the [RecaptchaV3Config](/docs/reference/appcheck/rest/v1beta/projects.apps.recaptchaV3Config#RecaptchaV3Config)s for the specified list of apps. |\n| ### [get](/docs/reference/appcheck/rest/v1beta/projects.apps.recaptchaV3Config/get) | Gets the [RecaptchaV3Config](/docs/reference/appcheck/rest/v1beta/projects.apps.recaptchaV3Config#RecaptchaV3Config) for the specified app. |\n| ### [patch](/docs/reference/appcheck/rest/v1beta/projects.apps.recaptchaV3Config/patch) | Updates the [RecaptchaV3Config](/docs/reference/appcheck/rest/v1beta/projects.apps.recaptchaV3Config#RecaptchaV3Config) for the specified app. |"]]
