Google Cloud reCAPTCHA Enterprise v1 API - Class ProtectedEndpoint (2.21.0) 

public sealed class ProtectedEndpoint : IMessage<ProtectedEndpoint>, IEquatable<ProtectedEndpoint>, IDeepCloneable<ProtectedEndpoint>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class ProtectedEndpoint.

Configuration for an API endpoint to protect with reCAPTCHA.

Inheritance

object > ProtectedEndpoint

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

ProtectedEndpoint()

public ProtectedEndpoint()

ProtectedEndpoint(ProtectedEndpoint)

public ProtectedEndpoint(ProtectedEndpoint other)
Parameter
Name Description
other ProtectedEndpoint

Properties

Action

public string Action { get; set; }

Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.

Property Value
Type Description
string

Path

public string Path { get; set; }

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:

  • /login matches /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.
Property Value
Type Description
string