Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace HumanInteractionChallenge

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.

Properties

Optional action

action: Action

The action to take against requests from detected bots. If unspecified, defaults to {@code DETECT}.

Optional actionExpirationInSeconds

actionExpirationInSeconds: undefined | number

The number of seconds between challenges for the same IP address. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional challengeSettings

challengeSettings: model.BlockChallengeSettings

Optional failureThreshold

failureThreshold: undefined | number

The number of failed requests before taking action. If unspecified, defaults to {@code 10}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional failureThresholdExpirationInSeconds

failureThresholdExpirationInSeconds: undefined | number

The number of seconds before the failure threshold resets. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional interactionThreshold

interactionThreshold: undefined | number

The number of interactions required to pass the challenge. If unspecified, defaults to {@code 3}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

isEnabled

isEnabled: boolean

Enables or disables the human interaction challenge Web Application Firewall feature.

Optional isNatEnabled

isNatEnabled: undefined | false | true

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.

Optional recordingPeriodInSeconds

recordingPeriodInSeconds: undefined | number

The number of seconds to record the interactions from the user. If unspecified, defaults to {@code 15}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional setHttpHeader

setHttpHeader: model.Header

Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the {@code action} is set to {@code DETECT}.

Functions

getDeserializedJsonObj

getJsonObj