{
  "id": "string",
  "folder_id": "string",
  "cloud_id": "string",
  "client_key": "string",
  "created_at": "google.protobuf.Timestamp",
  "name": "string",
  "allowed_sites": [
    "string"
  ],
  "complexity": "CaptchaComplexity",
  "style_json": "string",
  "suspend": "bool",
  "turn_off_hostname_check": "bool",
  "pre_check_type": "CaptchaPreCheckType",
  "challenge_type": "CaptchaChallengeType",
  "security_rules": [
    {
      "name": "string",
      "priority": "int64",
      "description": "string",
      "condition": {
        "host": {
          "hosts": [
            {
              // Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`
              "exact_match": "string",
              "exact_not_match": "string",
              "prefix_match": "string",
              "prefix_not_match": "string",
              "pire_regex_match": "string",
              "pire_regex_not_match": "string"
              // end of the list of possible fields
            }
          ]
        },
        "uri": {
          "path": {
            // Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`
            "exact_match": "string",
            "exact_not_match": "string",
            "prefix_match": "string",
            "prefix_not_match": "string",
            "pire_regex_match": "string",
            "pire_regex_not_match": "string"
            // end of the list of possible fields
          },
          "queries": [
            {
              "key": "string",
              "value": {
                // Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`
                "exact_match": "string",
                "exact_not_match": "string",
                "prefix_match": "string",
                "prefix_not_match": "string",
                "pire_regex_match": "string",
                "pire_regex_not_match": "string"
                // end of the list of possible fields
              }
            }
          ]
        },
        "headers": [
          {
            "name": "string",
            "value": {
              // Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`
              "exact_match": "string",
              "exact_not_match": "string",
              "prefix_match": "string",
              "prefix_not_match": "string",
              "pire_regex_match": "string",
              "pire_regex_not_match": "string"
              // end of the list of possible fields
            }
          }
        ],
        "source_ip": {
          "ip_ranges_match": {
            "ip_ranges": [
              "string"
            ]
          },
          "ip_ranges_not_match": {
            "ip_ranges": [
              "string"
            ]
          },
          "geo_ip_match": {
            "locations": [
              "string"
            ]
          },
          "geo_ip_not_match": {
            "locations": [
              "string"
            ]
          }
        }
      },
      "override_variant_uuid": "string"
    }
  ],
  "deletion_protection": "bool",
  "override_variants": [
    {
      "uuid": "string",
      "description": "string",
      "complexity": "CaptchaComplexity",
      "pre_check_type": "CaptchaPreCheckType",
      "challenge_type": "CaptchaChallengeType"
    }
  ],
  "disallow_data_processing": "bool",
  "description": "string",
  "labels": "map<string, string>"
}

A Captcha resource.

Field	Description
id	string ID of the captcha.
folder_id	string ID of the folder that the captcha belongs to.
cloud_id	string ID of the cloud that the captcha belongs to.
client_key	string Client key of the captcha, see CAPTCHA keys.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the captcha. The name is unique within the folder. 3-63 characters long.
allowed_sites[]	string List of allowed host names, see Domain validation.
complexity	enum CaptchaComplexity Complexity of the captcha. `EASY`: High chance to pass pre-check and easy advanced challenge. `MEDIUM`: Medium chance to pass pre-check and normal advanced challenge. `HARD`: Little chance to pass pre-check and hard advanced challenge. `FORCE_HARD`: Impossible to pass pre-check and hard advanced challenge.
style_json	string JSON with variables to define the captcha appearance. For more details see generated JSON in cloud console.
suspend	bool Determines that the captcha is currently in restricted mode, see SmartCaptcha restricted mode.
turn_off_hostname_check	bool Turn off host name check, see Domain validation.
pre_check_type	enum CaptchaPreCheckType Basic check type of the captcha. `CHECKBOX`: User must click the "I am not a robot" button. `SLIDER`: User must move the slider from left to right.
challenge_type	enum CaptchaChallengeType Additional task type of the captcha. `IMAGE_TEXT`: Text recognition: The user has to type a distorted text from the picture into a special field. `SILHOUETTES`: Silhouettes: The user has to mark several icons from the picture in a particular order. `KALEIDOSCOPE`: Kaleidoscope: The user has to build a picture from individual parts by shuffling them using a slider.
security_rules[]	SecurityRule List of security rules.
deletion_protection	bool Determines whether captcha is protected from being deleted.
override_variants[]	OverrideVariant List of variants to use in security_rules The maximum number of elements is 32.
disallow_data_processing	bool
description	string The maximum string length in characters is 512.
labels	object (map<string, string>) No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_0-9a-z]`. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]`.

SecurityRule

SecurityRule object. Defines the condition and action: when and which variant to show.

Field	Description
name	string Required field. Name of the rule. The name is unique within the captcha. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression `[a-zA-Z0-9][a-zA-Z0-9-_.]*`.
priority	int64 Priority of the rule. Lower value means higher priority. Acceptable values are 1 to 999999, inclusive.
description	string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512.
condition	Condition The condition for matching the rule.
override_variant_uuid	string Variant UUID to show in case of match the rule. Keep empty to use defaults.

Condition

Condition object. AND semantics implied.

Field	Description
host	HostMatcher Host where captcha placed.
uri	UriMatcher URI where captcha placed.
headers[]	HeaderMatcher Captcha request headers. The maximum number of elements is 20.
source_ip	IpMatcher The IP address of the requester.

HostMatcher

HostMatcher object.

Field

Description

hosts[]

StringMatcher

List of hosts. OR semantics implied.

The maximum number of elements is 20.

StringMatcher

StringMatcher object.

Field	Description
exact_match	string The string length in characters must be 0-255. Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
exact_not_match	string The string length in characters must be 0-255. Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
prefix_match	string The string length in characters must be 0-255. Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
prefix_not_match	string The string length in characters must be 0-255. Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
pire_regex_match	string The string length in characters must be 0-255. Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
pire_regex_not_match	string The string length in characters must be 0-255. Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.

UriMatcher

UriMatcher object. AND semantics implied.

Field

Description

path

StringMatcher

Path of the URI RFC3986.

queries[]

QueryMatcher

List of query matchers. AND semantics implied.

The maximum number of elements is 20.

QueryMatcher

QueryMatcher object.

Field

Description

key

string

Required field. Key of the query parameter.

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the query parameter.

HeaderMatcher

HeaderMatcher object.

Field

Description

name

string

Required field. Name of header (case insensitive).

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the header.

IpMatcher

IpMatcher object. AND semantics implied.

Field	Description
ip_ranges_match	IpRangesMatcher
ip_ranges_not_match	IpRangesMatcher
geo_ip_match	GeoIpMatcher
geo_ip_not_match	GeoIpMatcher

IpRangesMatcher

IpRangesMatcher object.

Field

Description

ip_ranges[]

string

List of IP ranges. OR semantics implied.

The maximum number of elements is 10000.

GeoIpMatcher

GeoIpMatcher object.

Field

Description

locations[]

string

ISO 3166-1 alpha 2. OR semantics implied.

The minimum number of elements is 1.

OverrideVariant

OverrideVariant object. Contains the settings to override.

Field	Description
uuid	string Unique identifier of the variant. Value must match the regular expression `[a-zA-Z0-9][a-zA-Z0-9-_.]*`. The maximum string length in characters is 64.
description	string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512.
complexity	enum CaptchaComplexity Complexity of the captcha. `EASY`: High chance to pass pre-check and easy advanced challenge. `MEDIUM`: Medium chance to pass pre-check and normal advanced challenge. `HARD`: Little chance to pass pre-check and hard advanced challenge. `FORCE_HARD`: Impossible to pass pre-check and hard advanced challenge.
pre_check_type	enum CaptchaPreCheckType Basic check type of the captcha. `CHECKBOX`: User must click the "I am not a robot" button. `SLIDER`: User must move the slider from left to right.
challenge_type	enum CaptchaChallengeType Additional task type of the captcha. `IMAGE_TEXT`: Text recognition: The user has to type a distorted text from the picture into a special field. `SILHOUETTES`: Silhouettes: The user has to mark several icons from the picture in a particular order. `KALEIDOSCOPE`: Kaleidoscope: The user has to build a picture from individual parts by shuffling them using a slider.

SmartCaptcha API, gRPC: CaptchaService.Get

gRPC requestgRPC request

GetCaptchaRequestGetCaptchaRequest

CaptchaCaptcha

SecurityRuleSecurityRule

ConditionCondition

HostMatcherHostMatcher

StringMatcherStringMatcher

UriMatcherUriMatcher

QueryMatcherQueryMatcher

HeaderMatcherHeaderMatcher

IpMatcherIpMatcher

IpRangesMatcherIpRangesMatcher

GeoIpMatcherGeoIpMatcher

OverrideVariantOverrideVariant

Была ли статья полезна?

gRPC request

GetCaptchaRequest

Captcha

SecurityRule

Condition

HostMatcher

StringMatcher

UriMatcher

QueryMatcher

HeaderMatcher

IpMatcher

IpRangesMatcher

GeoIpMatcher

OverrideVariant