Show / Hide Table of Contents

Namespace Oci.WafService.Models

Classes

AccessControlRule

Rule that represents Request/Response Access Control. Only actions of the following types are allowed to be referenced in this rule:

  • CHECK
  • ALLOW
  • RETURN_HTTP_RESPONSE

Action

An object that represents action and its options. The action can be terminating, if it stops further execution of rules and modules. And non-terminating, if it does not interrupt execution flow.

ActionModelConverter

AllowAction

An object that represents an action which upon matching rule skips all remaining rules in the current module.

ChangeNetworkAddressListCompartmentDetails

Updates compartmentId of resource.

ChangeResourceCompartmentDetails

Updates compartmentId of resource.

ChangeWebAppFirewallCompartmentDetails

Updates compartmentId of resource.

ChangeWebAppFirewallPolicyCompartmentDetails

Updates compartmentId of resource.

CheckAction

An object that represents an action which does not stop the execution of rules in current module, just emits a log message documenting result of rule execution.

CollaborativeCapabilityWeight

Defines how much a contributing capability contributes towards the action threshold of a collaborative protection capability.

CollaborativeCapabilityWeightOverride

Collaborative capability key and overriding weight.

CreateNetworkAddressListAddressesDetails

The information about new NetworkAddressListAddresses.

CreateNetworkAddressListDetails

The information about new NetworkAddressList.

CreateNetworkAddressListDetailsModelConverter

CreateNetworkAddressListVcnAddressesDetails

The information about new NetworkAddressListVcnAddresses.

CreateWebAppFirewallDetails

The information about new Web App Firewall.

CreateWebAppFirewallDetailsModelConverter

CreateWebAppFirewallLoadBalancerDetails

The information about new WebAppFirewallLoadBalancer.

CreateWebAppFirewallPolicyDetails

The information about new WebAppFirewallPolicy.

DynamicHttpResponseBody

Allows returning dynamically generated HTTP response body based on the provided template. The template allows variable interpolation by specifying variable name between the '${' and '}' delimiters. Escape sequences using '\' are supported to allow usage of '\\' and '\${' in the template to return '\' and '\${' in final response.
The following variables are supported:

  • http.request.id - the HTTP request ID. For Example: "d5fa953f75ef417e4c8008ef9336d779".

HttpResponseBody

Type of returned HTTP response body.

HttpResponseBodyModelConverter

NetworkAddressList

IP addresses that can be used between different WebAppFirewallPolicies.

NetworkAddressListAddresses

A NetworkAddressList that contains addresses.

NetworkAddressListAddressesSummary

Summary of NetworkAddressListAddresses.

NetworkAddressListCollection

Contains NetworkAddressListSummary items.

NetworkAddressListModelConverter

NetworkAddressListSummary

Summary of NetworkAddressList.

NetworkAddressListSummaryModelConverter

NetworkAddressListVcnAddresses

A NetworkAddressList that contains VCN addresses.

NetworkAddressListVcnAddressesSummary

Summary of NetworkAddressListVcnAddresses.

PrivateAddresses

A pair of VCN OCID and private IP address prefix in CIDR notation.

ProtectionCapability

References an OCI-managed protection capability. Checks if HTTP requests/responses are malicious.

ProtectionCapabilityCollection

Result of a protection capabilities search.

ProtectionCapabilityExclusions

Identifies specific HTTP message parameters to exclude from inspection by a protection capability.

ProtectionCapabilityGroupTagCollection

Result of a protection capabilities group tags search.

ProtectionCapabilityGroupTagSummary

Object representing protection cabapility group tag and its metadata.

ProtectionCapabilitySettings

Settings for protection capabilities

ProtectionCapabilitySummary

A summary of available OCI-managed protection capabilities in WebAppFirewallPolicy. Protection capabilies checks HTTP requests/responses if they are malicious.

ProtectionRule

Rule that represents Request/Response Protection. Only actions of the following types are allowed to be referenced in this rule:

  • CHECK
  • RETURN_HTTP_RESPONSE

RequestAccessControl

Module that allows inspection of HTTP request properties and to return a defined HTTP response. In this module, rules with the name 'Default Action' are not allowed, since this name is reserved for default action logs.

RequestProtection

Module that allows to enable OCI-managed protection capabilities for incoming HTTP requests.

RequestRateLimiting

Module that allows inspection of HTTP connection properties and to limit requests frequency for a given key.

RequestRateLimitingConfiguration

Rate limiting configuration.

RequestRateLimitingRule

Rule that represents RequestRateLimitingConfigurations. Only actions of the following types are allowed to be referenced in this rule:

  • CHECK
  • RETURN_HTTP_RESPONSE

ResponseAccessControl

Module that allows inspection of HTTP response properties and to return a defined HTTP response.

ResponseHeader

A header field to add to a response.

ResponseProtection

Module that allows to enable OCI-managed protection capabilities for HTTP responses.

ReturnHttpResponseAction

An object that represents an action which returns a defined HTTP response.

StaticTextHttpResponseBody

Allows returning static text as HTTP response body. Example: { "type": "STATIC_TEXT", "text": "{\ \"code\": 403,\ \"message\":\"Unauthorised\"}"}

UpdateNetworkAddressListAddressesDetails

The information to be updated for NetworkAddressListAddresses.

UpdateNetworkAddressListDetails

The information to be updated.

UpdateNetworkAddressListDetailsModelConverter

UpdateNetworkAddressListVcnAddressesDetails

The information to be updated for NetworkAddressListVcnAddresses.

UpdateWebAppFirewallDetails

The information to be updated for WebAppFirewall.

UpdateWebAppFirewallPolicyDetails

The information to be updated. When updating WebAppFirewallPolicy, shallow merge is used for all top-level fields, meaning that top-level fields with defined values are completely overwritten and top-level fields without defined values are unchanged.

WebAppFirewall

A resource connecting a WebAppFirewallPolicy to a backend of particular type, applying that policy's coverage to the backend.

WebAppFirewallCollection

Result of a WebAppFirewall list operation.

WebAppFirewallLoadBalancer

WebAppFirewall to a LoadBalancer resource.

WebAppFirewallLoadBalancerSummary

Summary of the WebAppFirewallLoadBalancer.

WebAppFirewallModelConverter

WebAppFirewallPolicy

The details of WebAppFirewallPolicy. A policy is comprised of rules, which allows executing inspections of incoming/outgoing HTTP message parameters and execution of actions, based on results of rules execution.
In policy, rules are grouped into modules by their functionality. Modules can be further divided by the type of HTTP messages they handle: Modules that inspect incoming HTTP request. These modules are executed in the order they are enumerated here: * requestAccessControl * requestRateLimiting * requestProtection
Modules that inspect outgoing HTTP responses. These modules are executed in the order they are enumerated here:

  • responseAccessControl
  • responseProtection

WebAppFirewallPolicyCollection

Contains WebAppFirewallPolicySummary items.

WebAppFirewallPolicyRule

Base schema for WebAppFirewallPolicyRules, including properties common to all of them.

WebAppFirewallPolicyRuleModelConverter

WebAppFirewallPolicySummary

Summary of the WebAppFirewallPolicy.

WebAppFirewallSummary

Summary of the WebAppFirewall.

WebAppFirewallSummaryModelConverter

WorkRequest

A description of WorkRequest status

WorkRequestCollection

Result of a WorkRequest search. Contains both WorkRequest items and other information, such as metadata.

WorkRequestError

An error encountered while executing a WorkRequest.

WorkRequestErrorCollection

Result of a WorkRequestError search. Contains both WorkRequestError items and other information, such as metadata.

WorkRequestLogEntry

A log message from the execution of a WorkRequest.

WorkRequestLogEntryCollection

Result of a WorkRequestLog search. Contains both WorkRequestLog items and other information, such as metadata.

WorkRequestResource

A resource created or operated on by a WorkRequest.

Enums

Action.TypeEnum

BackendType

Type of the WebAppFirewall, as example LOAD_BALANCER.

CreateNetworkAddressListDetails.TypeEnum

HttpResponseBody.TypeEnum

NetworkAddressList.LifecycleStateEnum

NetworkAddressList.TypeEnum

NetworkAddressListSummary.TypeEnum

ProtectionCapabilitySummary.TypeEnum

SortOrder

Sort orders.

UpdateNetworkAddressListDetails.TypeEnum

WebAppFirewall.LifecycleStateEnum

WebAppFirewallPolicy.LifecycleStateEnum

WebAppFirewallPolicyRule.ConditionLanguageEnum

WebAppFirewallPolicyRule.TypeEnum

WorkRequest.OperationTypeEnum

WorkRequest.StatusEnum

WorkRequestResource.ActionTypeEnum

In this article
Back to top