Interface UsernameField.Builder

  • Method Details

    • identifier

      UsernameField.Builder identifier(String identifier)

      The name of the username field.

      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

      Parameters:
      identifier - The name of the username field.

      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.