WebKeySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Settings specific to keys that can be used by websites.
Attributes |
|
|---|---|
| Name | Description |
allow_all_domains |
bool
Optional. If set to true, it means allowed_domains are not enforced. |
allowed_domains |
MutableSequence[str]
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.
|
allow_amp_traffic |
bool
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. |
integration_type |
google.cloud.recaptchaenterprise_v1.types.WebKeySettings.IntegrationType
Required. Describes how this key is integrated with the website. |
challenge_security_preference |
google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSecurityPreference
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.
|
challenge_settings |
google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSettings
Optional. Challenge settings. |
Classes
ActionSettings
ActionSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Per-action challenge settings.
ChallengeSecurityPreference
ChallengeSecurityPreference(value)Enum that represents the possible challenge frequency and difficulty configurations for a web key. Ensure that applications can handle values not explicitly listed.
ChallengeSettings
ChallengeSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered.
IntegrationType
IntegrationType(value)Enum that represents the integration types for web keys. Ensure that applications can handle values not explicitly listed.