Class ProtectionCapabilitySummary

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

Inheritance

object

ProtectionCapabilitySummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.WafService.Models

Assembly: OCI.DotNetSDK.Waf.dll

Syntax

public class ProtectionCapabilitySummary

Properties

CollaborativeActionThreshold

Declaration

[JsonProperty(PropertyName = "collaborativeActionThreshold")]
public int? CollaborativeActionThreshold { get; set; }

Property Value

Type

Description

int?

The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious. This field is ignored for non-collaborative capabilities.

CollaborativeWeights

Declaration

[JsonProperty(PropertyName = "collaborativeWeights")]
public List<CollaborativeCapabilityWeight> CollaborativeWeights { get; set; }

Property Value

Type	Description
List<CollaborativeCapabilityWeight>	The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability. This field is ignored for non-collaborative capabilities.

Description

Declaration

[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description of protection capability.

Remarks

Required

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The display name of protection capability.

Remarks

Required

GroupTags

Declaration

[JsonProperty(PropertyName = "groupTags")]
public List<string> GroupTags { get; set; }

Property Value

Type	Description
List<string>	The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]

IsLatestVersion

Declaration

[Required(ErrorMessage = "IsLatestVersion is required.")]
[JsonProperty(PropertyName = "isLatestVersion")]
public bool? IsLatestVersion { get; set; }

Property Value

Type	Description
bool?	The field that shows if this is the latest version of protection capability.

Remarks

Required

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
string	Unique key of protection capability.

Remarks

Required

Type

Declaration

[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ProtectionCapabilitySummary.TypeEnum? Type { get; set; }

Property Value

Type	Description
ProtectionCapabilitySummary.TypeEnum?	The type of protection capability. REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy. RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.

Remarks

Required

Version

Declaration

[Required(ErrorMessage = "Version is required.")]
[JsonProperty(PropertyName = "version")]
public int? Version { get; set; }

Property Value

Type	Description
int?	The version of protection capability.

Remarks

Required