GoogleCloudRecaptchaenterpriseV1WebKeySettings

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

Settings specific to keys that can be used by websites.

interface GoogleCloudRecaptchaenterpriseV1WebKeySettings {

allowAllDomains?: boolean;

allowAmpTraffic?: boolean;

allowedDomains?: string[];

challengeSecurityPreference?:

| "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED"

| "USABILITY"

| "BALANCE"

| "SECURITY";

challengeSettings?: GoogleCloudRecaptchaenterpriseV1WebKeySettingsChallengeSettings;

integrationType?:

| "INTEGRATION_TYPE_UNSPECIFIED"

| "SCORE"

| "CHECKBOX"

| "INVISIBLE"

| "POLICY_BASED_CHALLENGE";

}

§Properties

allowAllDomains?: boolean

[src]

Optional. If set to true, it means allowed_domains are not enforced.

allowAmpTraffic?: boolean

[src]

Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.

allowedDomains?: string[]

[src]

Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

challengeSecurityPreference?: "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED" | "USABILITY" | "BALANCE" | "SECURITY"

[src]

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationType CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.

challengeSettings?: GoogleCloudRecaptchaenterpriseV1WebKeySettingsChallengeSettings

[src]

Optional. Challenge settings.

integrationType?: "INTEGRATION_TYPE_UNSPECIFIED" | "SCORE" | "CHECKBOX" | "INVISIBLE" | "POLICY_BASED_CHALLENGE"

[src]

Required. Describes how this key is integrated with the website.