HumanInteractionChallenge

class oci.waas.models.HumanInteractionChallenge(**kwargs)

Bases: object

The human interaction challenge settings. The human interaction challenge checks various event listeners in the user’s browser to determine if there is a human user making a request.

Attributes:

ACTION_BLOCK

A constant which can be used with the action property of a HumanInteractionChallenge.

ACTION_DETECT

A constant which can be used with the action property of a HumanInteractionChallenge.

action

Gets the action of this HumanInteractionChallenge.

action_expiration_in_seconds

Gets the action_expiration_in_seconds of this HumanInteractionChallenge.

challenge_settings

Gets the challenge_settings of this HumanInteractionChallenge.

failure_threshold

Gets the failure_threshold of this HumanInteractionChallenge.

failure_threshold_expiration_in_seconds

Gets the failure_threshold_expiration_in_seconds of this HumanInteractionChallenge.

interaction_threshold

Gets the interaction_threshold of this HumanInteractionChallenge.

is_enabled

[Required] Gets the is_enabled of this HumanInteractionChallenge.

is_nat_enabled

Gets the is_nat_enabled of this HumanInteractionChallenge.

recording_period_in_seconds

Gets the recording_period_in_seconds of this HumanInteractionChallenge.

set_http_header

Gets the set_http_header of this HumanInteractionChallenge.

Methods:

__init__(**kwargs)

Initializes a new HumanInteractionChallenge object with values from keyword arguments.

ACTION_BLOCK = 'BLOCK'

A constant which can be used with the action property of a HumanInteractionChallenge. This constant has a value of “BLOCK”

ACTION_DETECT = 'DETECT'

A constant which can be used with the action property of a HumanInteractionChallenge. This constant has a value of “DETECT”

__init__(**kwargs)

Initializes a new HumanInteractionChallenge object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • is_enabled (bool) – The value to assign to the is_enabled property of this HumanInteractionChallenge.

  • action (str) – The value to assign to the action property of this HumanInteractionChallenge. Allowed values for this property are: “DETECT”, “BLOCK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • failure_threshold (int) – The value to assign to the failure_threshold property of this HumanInteractionChallenge.

  • action_expiration_in_seconds (int) – The value to assign to the action_expiration_in_seconds property of this HumanInteractionChallenge.

  • failure_threshold_expiration_in_seconds (int) – The value to assign to the failure_threshold_expiration_in_seconds property of this HumanInteractionChallenge.

  • interaction_threshold (int) – The value to assign to the interaction_threshold property of this HumanInteractionChallenge.

  • recording_period_in_seconds (int) – The value to assign to the recording_period_in_seconds property of this HumanInteractionChallenge.

  • set_http_header (oci.waas.models.Header) – The value to assign to the set_http_header property of this HumanInteractionChallenge.

  • challenge_settings (oci.waas.models.BlockChallengeSettings) – The value to assign to the challenge_settings property of this HumanInteractionChallenge.

  • is_nat_enabled (bool) – The value to assign to the is_nat_enabled property of this HumanInteractionChallenge.

property action

Gets the action of this HumanInteractionChallenge. The action to take against requests from detected bots. If unspecified, defaults to DETECT.

Allowed values for this property are: “DETECT”, “BLOCK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The action of this HumanInteractionChallenge.

Return type

str

property action_expiration_in_seconds

Gets the action_expiration_in_seconds of this HumanInteractionChallenge. The number of seconds between challenges for the same IP address. If unspecified, defaults to 60.

Returns

The action_expiration_in_seconds of this HumanInteractionChallenge.

Return type

int

property challenge_settings

Gets the challenge_settings of this HumanInteractionChallenge.

Returns

The challenge_settings of this HumanInteractionChallenge.

Return type

oci.waas.models.BlockChallengeSettings

property failure_threshold

Gets the failure_threshold of this HumanInteractionChallenge. The number of failed requests before taking action. If unspecified, defaults to 10.

Returns

The failure_threshold of this HumanInteractionChallenge.

Return type

int

property failure_threshold_expiration_in_seconds

Gets the failure_threshold_expiration_in_seconds of this HumanInteractionChallenge. The number of seconds before the failure threshold resets. If unspecified, defaults to 60.

Returns

The failure_threshold_expiration_in_seconds of this HumanInteractionChallenge.

Return type

int

property interaction_threshold

Gets the interaction_threshold of this HumanInteractionChallenge. The number of interactions required to pass the challenge. If unspecified, defaults to 3.

Returns

The interaction_threshold of this HumanInteractionChallenge.

Return type

int

property is_enabled

[Required] Gets the is_enabled of this HumanInteractionChallenge. Enables or disables the human interaction challenge Web Application Firewall feature.

Returns

The is_enabled of this HumanInteractionChallenge.

Return type

bool

property is_nat_enabled

Gets the is_nat_enabled of this HumanInteractionChallenge. When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.

Returns

The is_nat_enabled of this HumanInteractionChallenge.

Return type

bool

property recording_period_in_seconds

Gets the recording_period_in_seconds of this HumanInteractionChallenge. The number of seconds to record the interactions from the user. If unspecified, defaults to 15.

Returns

The recording_period_in_seconds of this HumanInteractionChallenge.

Return type

int

property set_http_header

Gets the set_http_header of this HumanInteractionChallenge. Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the action is set to DETECT.

Returns

The set_http_header of this HumanInteractionChallenge.

Return type

oci.waas.models.Header