ProtectionRuleExclusion

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

Bases: object

Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the exclusions field, the protection rule will not be executed. Rules can have more than one exclusion and exclusions are applied to requests disjunctively, meaning the specified exclusion strings are independently matched against the specified targets of a request. The first target to match a specified string will trigger an exclusion. Example: If the following exclusions are defined for a protection rule:

“action”: “BLOCK”, “exclusions”: [ { “target”:”REQUEST_COOKIES”, “exclusions”:[“example.com”, “12345”, “219ffwef9w0f”] }, { “target”:”REQUEST_COOKIE_NAMES”, “exclusions”:[“OAMAuthnCookie”, “JSESSIONID”, “HCM-PSJSESSIONID”] } ], “key”: “1000000”,

A request with the cookie name sessionid would trigger an exclusion. A request with the cookie name yourcompany.com would not trigger and exclusion.

Attributes

TARGET_ARGS A constant which can be used with the target property of a ProtectionRuleExclusion.
TARGET_ARGS_NAMES A constant which can be used with the target property of a ProtectionRuleExclusion.
TARGET_REQUEST_COOKIES A constant which can be used with the target property of a ProtectionRuleExclusion.
TARGET_REQUEST_COOKIE_NAMES A constant which can be used with the target property of a ProtectionRuleExclusion.
exclusions Gets the exclusions of this ProtectionRuleExclusion.
target Gets the target of this ProtectionRuleExclusion.

Methods

__init__(**kwargs) Initializes a new ProtectionRuleExclusion object with values from keyword arguments.
TARGET_ARGS = 'ARGS'

A constant which can be used with the target property of a ProtectionRuleExclusion. This constant has a value of “ARGS”

TARGET_ARGS_NAMES = 'ARGS_NAMES'

A constant which can be used with the target property of a ProtectionRuleExclusion. This constant has a value of “ARGS_NAMES”

TARGET_REQUEST_COOKIES = 'REQUEST_COOKIES'

A constant which can be used with the target property of a ProtectionRuleExclusion. This constant has a value of “REQUEST_COOKIES”

A constant which can be used with the target property of a ProtectionRuleExclusion. This constant has a value of “REQUEST_COOKIE_NAMES”

__init__(**kwargs)

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

Parameters:
  • target (str) – The value to assign to the target property of this ProtectionRuleExclusion. Allowed values for this property are: “REQUEST_COOKIES”, “REQUEST_COOKIE_NAMES”, “ARGS”, “ARGS_NAMES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • exclusions (list[str]) – The value to assign to the exclusions property of this ProtectionRuleExclusion.
exclusions

Gets the exclusions of this ProtectionRuleExclusion.

Returns:The exclusions of this ProtectionRuleExclusion.
Return type:list[str]
target

Gets the target of this ProtectionRuleExclusion. The target of the exclusion.

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

Returns:The target of this ProtectionRuleExclusion.
Return type:str