Skip to content

ResponseInspectionHeader

Source code in docs_src/capo_wafv2/types/response_inspection_header.py 
15
16
17
18
19
20
21
22
23
class ResponseInspectionHeader(TypedDict, closed=True):
    name: (
        "capo_wafv2.types.response_inspection_header_name.ResponseInspectionHeaderName"
    )
    """<p>The name of the header to match against. The name must be an exact match, including case.</p> <p>JSON example: <code>"Name": [ "RequestResult" ]</code> </p>"""
    success_values: "capo_wafv2.types.response_inspection_header_success_values.ResponseInspectionHeaderSuccessValues"
    """<p>Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values. </p> <p>JSON examples: <code>"SuccessValues": [ "LoginPassed", "Successful login" ]</code> and <code>"SuccessValues": [ "AccountCreated", "Successful account creation" ]</code> </p>"""
    failure_values: "capo_wafv2.types.response_inspection_header_failure_values.ResponseInspectionHeaderFailureValues"
    """<p>Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values. </p> <p>JSON examples: <code>"FailureValues": [ "LoginFailed", "Failed login" ]</code> and <code>"FailureValues": [ "AccountCreationFailed" ]</code> </p>"""

failure_values instance-attribute 

failure_values: ResponseInspectionHeaderFailureValues

Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]

name instance-attribute 

name: ResponseInspectionHeaderName

The name of the header to match against. The name must be an exact match, including case.

JSON example: "Name": [ "RequestResult" ]

success_values instance-attribute 

success_values: ResponseInspectionHeaderSuccessValues

Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]