GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

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

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.

interface GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig {

name?: string;

riskAnalysis?: GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis;

siteKey?: string;

tokenTtl?: number;

}

§Properties

name?: string

[src]

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

riskAnalysis?: GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis

[src]

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.

siteKey?: string

[src]

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 site_secret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.

tokenTtl?: number

[src]

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.