yandex_smartcaptcha_captcha (Data Source)

Get information about Yandex SmartCaptcha. For more information, see the official documentation.This data source is used to define Captcha that can be used by other resources.

Example UsageExample Usage

//
// Get SmartCaptcha details by Id.
//
data "yandex_smartcaptcha_captcha" "by-id" {
  captcha_id = yandex_smartcaptcha_captcha.my-captcha.id
}

//
// Get SmartCaptcha details by Name.
//
data "yandex_smartcaptcha_captcha" "by-name" {
  name = yandex_smartcaptcha_captcha.my-captcha.name
}

SchemaSchema

OptionalOptional

• captcha_id (String) ID of the Captcha.
• cloud_id (String) The Cloud ID which resource belongs to. If it is not provided, the default provider cloud-id is used.
• folder_id (String) The folder identifier that resource belongs to. If it is not provided, the default provider folder-id is used.
• name (String) The resource name.

Read-OnlyRead-Only

• allowed_sites (List of String) List of allowed host names, see Domain validation.
• challenge_type (String) Additional task type of the captcha. Possible values:

• 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.

• client_key (String) Client key of the captcha, see CAPTCHA keys.
• complexity (String) Complexity of the captcha. Possible values:

• 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.

• created_at (String) The creation timestamp of the resource.
• deletion_protection (Boolean) The true value means that resource is protected from accidental deletion.
• id (String) The ID of this resource.
• override_variant (List of Object) (see below for nested schema)
• pre_check_type (String) Basic check type of the captcha.Possible values:

• CHECKBOX - User must click the 'I am not a robot' button.
• SLIDER - User must move the slider from left to right.

• security_rule (List of Object) (see below for nested schema)
• style_json (String) JSON with variables to define the captcha appearance. For more details see generated JSON in cloud console.
• suspend (Boolean)
• turn_off_hostname_check (Boolean) Turn off host name check, see Domain validation.

Nested Schema for Nested Schema for override_variant

Read-Only:

• challenge_type (String) Additional task type of the captcha.

• complexity (String) Complexity of the captcha.

• description (String) Optional description of the rule. 0-512 characters long.

• pre_check_type (String) Basic check type of the captcha.

• uuid (String) Unique identifier of the variant.

Nested Schema for Nested Schema for security_rule

Read-Only:

• condition (Block List, Max: 1) The condition for matching the rule. You can find all possibilities of condition in gRPC specs. (see below for nested schema)

• description (String) Description of the rule. 0-512 characters long.

• name (String) Name of the rule. The name is unique within the captcha. 1-50 characters long.

• override_variant_uuid (String) Variant UUID to show in case of match the rule. Keep empty to use defaults.

• priority (Number) Priority of the rule. Lower value means higher priority.

Nested Schema for Nested Schema for security_rule.condition

Read-Only:

• headers (List of Object) (see below for nested schema)
• host (List of Object) (see below for nested schema)
• source_ip (List of Object) (see below for nested schema)
• uri (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.headers

Read-Only:

• name (String)
• value (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.headers.value

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for security_rule.condition.host

Read-Only:

• hosts (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.host.hosts

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for security_rule.condition.source_ip

Read-Only:

• geo_ip_match (List of Object) (see below for nested schema)
• geo_ip_not_match (List of Object) (see below for nested schema)
• ip_ranges_match (List of Object) (see below for nested schema)
• ip_ranges_not_match (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.source_ip.geo_ip_match

Read-Only:

• locations (List of String)

Nested Schema for Nested Schema for security_rule.condition.source_ip.geo_ip_not_match

Read-Only:

• locations (List of String)

Nested Schema for Nested Schema for security_rule.condition.source_ip.ip_ranges_match

Read-Only:

• ip_ranges (List of String)

Nested Schema for Nested Schema for security_rule.condition.source_ip.ip_ranges_not_match

Read-Only:

• ip_ranges (List of String)

Nested Schema for Nested Schema for security_rule.condition.uri

Read-Only:

• path (List of Object) (see below for nested schema)
• queries (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.uri.path

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for security_rule.condition.uri.queries

Read-Only:

• key (String)
• value (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.uri.queries.value

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)