Skip to content

RequestInspection

Source code in docs_src/capo_wafv2/types/request_inspection.py 
15
16
17
18
19
20
21
class RequestInspection(TypedDict, closed=True):
    payload_type: "capo_wafv2.types.payload_type.PayloadType"
    """<p>The payload type for your login endpoint, either JSON or form encoded.</p>"""
    username_field: "capo_wafv2.types.username_field.UsernameField"
    """<p>The name of the field in the request payload that contains your customer's username. </p> <p>How you specify this depends on the request inspection payload type.</p> <ul> <li> <p>For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation <a href="https://tools.ietf.org/html/rfc6901">JavaScript Object Notation (JSON) Pointer</a>. </p> <p>For example, for the JSON payload <code>{ "form": { "username": "THE_USERNAME" } }</code>, the username field specification is <code>/form/username</code>. </p> </li> <li> <p>For form encoded payload types, use the HTML form names.</p> <p>For example, for an HTML form with the input element named <code>username1</code>, the username field specification is <code>username1</code> </p> </li> </ul>"""
    password_field: "capo_wafv2.types.password_field.PasswordField"
    """<p>The name of the field in the request payload that contains your customer's password. </p> <p>How you specify this depends on the request inspection payload type.</p> <ul> <li> <p>For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation <a href="https://tools.ietf.org/html/rfc6901">JavaScript Object Notation (JSON) Pointer</a>. </p> <p>For example, for the JSON payload <code>{ "form": { "password": "THE_PASSWORD" } }</code>, the password field specification is <code>/form/password</code>.</p> </li> <li> <p>For form encoded payload types, use the HTML form names.</p> <p>For example, for an HTML form with the input element named <code>password1</code>, the password field specification is <code>password1</code>.</p> </li> </ul>"""

password_field instance-attribute 

password_field: PasswordField

The name of the field in the request payload that contains your customer's password.

How you specify this depends on the request inspection payload type.

  • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

    For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

  • For form encoded payload types, use the HTML form names.

    For example, for an HTML form with the input element named password1, the password field specification is password1.

payload_type instance-attribute 

payload_type: PayloadType

The payload type for your login endpoint, either JSON or form encoded.

username_field instance-attribute 

username_field: UsernameField

The name of the field in the request payload that contains your customer's username.

How you specify this depends on the request inspection payload type.

  • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

    For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

  • For form encoded payload types, use the HTML form names.

    For example, for an HTML form with the input element named username1, the username field specification is username1