CSRFPolicy

CSRFPolicy
CSRFPolicy
JSON Example
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "cookie_name": "string",
    "description": "string",
    "name": "string",
    "rules": [
        {
            "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"
        }
    ],
    "tenant_ref": "string",
    "token_validity_time_min": 0,
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

configpb_attributes
Optional

configpb_attributes

string
cookie_name
Optional
Constraints: default: X-CSRF-TOKEN

Name of the cookie to be used for CSRF token. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
description
Optional

Human-readable description of this CSRF Protection Policy. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Required

The name of this CSRF Protection Policy. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of CSRFRule
rules
Optional

Rules to control which requests undergo CSRF Protection.If the client's request doesn't match with any rules MatchTarget, BYPASS_CSRF action is applied. Field introduced in 30.2.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type Tenant. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
token_validity_time_min
Optional
Constraints: default: 360

CSRF token is rotated when this time expires. Tokens will be acceptable for twice the token_validity_time time. Allowed values are 10-1440. Special values are 0- unlimited. Field introduced in 30.2.1. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

A unique identifier to this CSRF Protection Policy. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.