CSRFRule

CSRFRule
CSRFRule
JSON Example
{
    "action": "string",
    "enable": false,
    "index": 0,
    "match": {
        "bot_detection_result": {
            "classifications": [
                {
                    "type": "string",
                    "user_defined_type": "string"
                }
            ],
            "match_operation": "string"
        },
        "client_ip": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "group_refs": [
                "string"
            ],
            "match_criteria": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        },
        "cookie": {
            "match_case": "string",
            "match_criteria": "string",
            "name": "string",
            "value": "string"
        },
        "geo_matches": [
            {
                "attribute": "string",
                "match_operation": "string",
                "values": [
                    "string"
                ]
            }
        ],
        "hdrs": [
            {
                "hdr": "string",
                "match_case": "string",
                "match_criteria": "string",
                "value": [
                    "string"
                ]
            }
        ],
        "host_hdr": {
            "match_case": "string",
            "match_criteria": "string",
            "value": [
                "string"
            ]
        },
        "ip_reputation_type": {
            "match_operation": "string",
            "reputation_types": [
                "string"
            ]
        },
        "method": {
            "match_criteria": "string",
            "methods": [
                "string"
            ]
        },
        "path": {
            "match_case": "string",
            "match_criteria": "string",
            "match_decoded_string": false,
            "match_str": [
                "string"
            ],
            "string_group_refs": [
                "string"
            ]
        },
        "protocol": {
            "match_criteria": "string",
            "protocols": "string"
        },
        "query": {
            "match_case": "string",
            "match_criteria": "string",
            "match_decoded_string": false,
            "match_str": [
                "string"
            ],
            "string_group_refs": [
                "string"
            ]
        },
        "source_ip": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "group_refs": [
                "string"
            ],
            "match_criteria": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        },
        "tls_fingerprint_match": {
            "fingerprints": [
                "string"
            ],
            "match_operation": "string",
            "string_group_refs": [
                "string"
            ]
        },
        "version": {
            "match_criteria": "string",
            "versions": [
                "string"
            ]
        },
        "vs_port": {
            "match_criteria": "string",
            "ports": [
                0
            ]
        }
    },
    "name": "string"
}
string
action
Optional
Constraints: default: VERIFY_ORIGIN_AND_CSRF_TOKEN

CSRF Action to be applied for matched target. Enum options - VERIFY_CSRF_TOKEN, VERIFY_ORIGIN, VERIFY_ORIGIN_AND_CSRF_TOKEN, BYPASS_CSRF. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable
Optional
Constraints: default: true

Enable or deactivate the rule. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
index
Required

Rules are processed in order of this index field. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

match
Required

match

string
name
Required

A name describing the rule in a short form. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Property Of