WafPolicyPSMGroup

WafPolicyPSMGroup
WafPolicyPSMGroup
JSON Example
{
    "_last_modified": "string",
    "completely_described_match_elements": [
        "string"
    ],
    "description": "string",
    "enable": false,
    "hit_action": "string",
    "is_learning_group": false,
    "location_match_miss_action": "string",
    "locations": [
        {
            "description": "string",
            "index": 0,
            "match": {
                "host": {
                    "match_case": "string",
                    "match_criteria": "string",
                    "value": [
                        "string"
                    ]
                },
                "methods": {
                    "match_criteria": "string",
                    "methods": [
                        "string"
                    ]
                },
                "path": {
                    "match_case": "string",
                    "match_criteria": "string",
                    "match_decoded_string": false,
                    "match_str": [
                        "string"
                    ],
                    "string_group_refs": [
                        "string"
                    ]
                }
            },
            "name": "string",
            "rules": [
                {
                    "description": "string",
                    "enable": false,
                    "ignore_hit_action": false,
                    "index": 0,
                    "match_case": "string",
                    "match_elements": [
                        {
                            "excluded": false,
                            "index": 0,
                            "match_case": "string",
                            "match_op": "string",
                            "name": "string",
                            "sub_element": "string"
                        }
                    ],
                    "match_value_max_length": 0,
                    "match_value_pattern": "string",
                    "match_value_string_group_key": "string",
                    "match_value_string_group_ref": "string",
                    "mode": "string",
                    "name": "string",
                    "paranoia_level": "string",
                    "rule_id": "string"
                }
            ]
        }
    ],
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "miss_action": "string",
    "name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

array of string
completely_described_match_elements
Optional

A list of all match element collections which are completely described in the PSM Group. Every input value which matches one of the elements in this list but is not handled by a WAF PSM rule, will run the match_element miss_action. Allowed values are WAF_VARIABLE_ARGS. Enum options - WAF_VARIABLE_ARGS, WAF_VARIABLE_ARGS_GET, WAF_VARIABLE_ARGS_POST, WAF_VARIABLE_ARGS_NAMES, WAF_VARIABLE_REQUEST_COOKIES, WAF_VARIABLE_QUERY_STRING, WAF_VARIABLE_REQUEST_BASENAME, WAF_VARIABLE_REQUEST_URI, WAF_VARIABLE_PATH_INFO, WAF_VARIABLE_REQUEST_HEADERS. Field introduced in 31.2.1. Maximum of 1 items allowed. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
description
Optional

Free-text comment about this group. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable
Optional
Constraints: default: true

Enable or disable this WAF rule group. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
hit_action
Optional
Constraints: default: WAF_ACTION_ALLOW_PARAMETER

If a rule in this group matches the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_ALLOW_PARAMETER. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
is_learning_group
Optional

This field indicates that this group is used for learning. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
location_match_miss_action
Optional
Constraints: default: WAF_ACTION_NO_OP

If there is no location matching the request, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_BLOCK. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

array of WafPSMLocation
locations
Optional

Positive Security Model locations. These are used to partition the application name space. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of RoleFilterMatchLabel
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
miss_action
Optional
Constraints: default: WAF_ACTION_NO_OP

If a rule in this group does not match the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_BLOCK. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

User defined name of the group. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of this object. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of
Parameter To
Returned By