Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::ProtectedEndpoint.
Configuration for an API endpoint to protect with reCAPTCHA.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#action
def action() -> ::String- (::String) — Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.
#action=
def action=(value) -> ::String- value (::String) — Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.
- (::String) — Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.
#path
def path() -> ::String-
(::String) —
Required. URI path of the API endpoint to protect. Must start with '/'. Supports glob characters '' to match a single path segment and '' to match multiple path segments. Standalone root catch-alls ('/' and '/**') are invalid because it can negatively impact performance to trigger reCAPTCHA on every single request to your backend.
Matching is evaluated against the URL path only (domain, scheme, and query parameters are ignored).
Examples:
/loginmatches/login,https://example.com/login, and/login?query=1, but not/login/step1./products/*matches/products/123, but not/products/123/456./content/**matches/content/articles/2024/01/01.
#path=
def path=(value) -> ::String-
value (::String) —
Required. URI path of the API endpoint to protect. Must start with '/'. Supports glob characters '' to match a single path segment and '' to match multiple path segments. Standalone root catch-alls ('/' and '/**') are invalid because it can negatively impact performance to trigger reCAPTCHA on every single request to your backend.
Matching is evaluated against the URL path only (domain, scheme, and query parameters are ignored).
Examples:
/loginmatches/login,https://example.com/login, and/login?query=1, but not/login/step1./products/*matches/products/123, but not/products/123/456./content/**matches/content/articles/2024/01/01.
-
(::String) —
Required. URI path of the API endpoint to protect. Must start with '/'. Supports glob characters '' to match a single path segment and '' to match multiple path segments. Standalone root catch-alls ('/' and '/**') are invalid because it can negatively impact performance to trigger reCAPTCHA on every single request to your backend.
Matching is evaluated against the URL path only (domain, scheme, and query parameters are ignored).
Examples:
/loginmatches/login,https://example.com/login, and/login?query=1, but not/login/step1./products/*matches/products/123, but not/products/123/456./content/**matches/content/articles/2024/01/01.