GoogleFirebaseAppcheckV1RecaptchaV3Config

import type { GoogleFirebaseAppcheckV1RecaptchaV3Config } from "https://googleapis.deno.dev/v1/firebaseappcheck:v1.ts";

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 AppCheckToken, such as its ttl.

interface GoogleFirebaseAppcheckV1RecaptchaV3Config {

minValidScore?: number;

name?: string;

siteSecret?: string;

readonly siteSecretSet?: boolean;

tokenTtl?: number;

}

§Properties

minValidScore?: number

[src]

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.

name?: string

[src]

Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaV3Config

siteSecret?: string

[src]

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.

readonly siteSecretSet?: boolean

[src]

Output only. Whether the site_secret field was previously set. Since we will never return the site_secret field, this field is the only way to find out whether it was previously set.

tokenTtl?: number

[src]

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.