reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::ClientSettings (v1.12.2)

Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::ClientSettings.

Configuration for clients to protect with reCAPTCHA.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_all_domains

def allow_all_domains() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, it means allowed_domains are not enforced.

#allow_all_domains=

def allow_all_domains=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, it means allowed_domains are not enforced.
Returns
  • (::Boolean) — Optional. If set to true, it means allowed_domains are not enforced.

#allowed_domains

def allowed_domains() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Domains or subdomains of websites allowed to use the policy. 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 policy supports a maximum of 250 domains. To use a policy 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.

#allowed_domains=

def allowed_domains=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Domains or subdomains of websites allowed to use the policy. 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 policy supports a maximum of 250 domains. To use a policy 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.
Returns
  • (::Array<::String>) — Optional. Domains or subdomains of websites allowed to use the policy. 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 policy supports a maximum of 250 domains. To use a policy 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.

#protected_endpoint_group

def protected_endpoint_group() -> ::Google::Cloud::RecaptchaEnterprise::V1::ProtectedEndpointGroup
Returns

#protected_endpoint_group=

def protected_endpoint_group=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::ProtectedEndpointGroup
Parameter
Returns