Class: Aws::WAFV2::Types::RequestInspectionACFP

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-wafv2/types.rb

Overview

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

This is part of the ‘AWSManagedRulesACFPRuleSet` configuration in `ManagedRuleGroupConfig`.

In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the fields within the request body where the username, password, email, and primary address and phone number fields are provided.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_fields ⇒ Array<Types::AddressField>

The names of the fields in the request payload that contain your customer’s primary physical address.

Order the address fields in the array exactly as they are ordered in the request payload.

How you specify the address fields depends on the request inspection payload type.

  • For JSON payloads, specify the field identifiers 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”: { “primaryaddressline1”: “THE_ADDRESS1”, “primaryaddressline2”: “THE_ADDRESS2”, “primaryaddressline3”: “THE_ADDRESS3” } }`, the address field idenfiers are `/form/primaryaddressline1`, `/form/primaryaddressline2`, and `/form/primaryaddressline3`.

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

    For example, for an HTML form with input elements named ‘primaryaddressline1`, `primaryaddressline2`, and `primaryaddressline3`, the address fields identifiers are `primaryaddressline1`, `primaryaddressline2`, and `primaryaddressline3`.

[1]: tools.ietf.org/html/rfc6901

Returns:



7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7301

class RequestInspectionACFP < Struct.new(
  :payload_type,
  :username_field,
  :password_field,
  :email_field,
  :phone_number_fields,
  :address_fields)
  SENSITIVE = []
  include Aws::Structure
end

#email_field ⇒ Types::EmailField

The name of the field in the request payload that contains your customer’s email.

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”: { “email”: “THE_EMAIL” } }`, the email field specification is `/form/email`.

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

    For example, for an HTML form with the input element named ‘email1`, the email field specification is `email1`.

[1]: tools.ietf.org/html/rfc6901

Returns:



7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7301

class RequestInspectionACFP < Struct.new(
  :payload_type,
  :username_field,
  :password_field,
  :email_field,
  :phone_number_fields,
  :address_fields)
  SENSITIVE = []
  include Aws::Structure
end

#password_field ⇒ Types::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`.

[1]: tools.ietf.org/html/rfc6901

Returns:



7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7301

class RequestInspectionACFP < Struct.new(
  :payload_type,
  :username_field,
  :password_field,
  :email_field,
  :phone_number_fields,
  :address_fields)
  SENSITIVE = []
  include Aws::Structure
end

#payload_type ⇒ String

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

Returns:

  • (String) 


7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7301

class RequestInspectionACFP < Struct.new(
  :payload_type,
  :username_field,
  :password_field,
  :email_field,
  :phone_number_fields,
  :address_fields)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number_fields ⇒ Array<Types::PhoneNumberField>

The names of the fields in the request payload that contain your customer’s primary phone number.

Order the phone number fields in the array exactly as they are ordered in the request payload.

How you specify the phone number fields depends on the request inspection payload type.

  • For JSON payloads, specify the field identifiers 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”: { “primaryphoneline1”: “THE_PHONE1”, “primaryphoneline2”: “THE_PHONE2”, “primaryphoneline3”: “THE_PHONE3” } }`, the phone number field identifiers are `/form/primaryphoneline1`, `/form/primaryphoneline2`, and `/form/primaryphoneline3`.

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

    For example, for an HTML form with input elements named ‘primaryphoneline1`, `primaryphoneline2`, and `primaryphoneline3`, the phone number field identifiers are `primaryphoneline1`, `primaryphoneline2`, and `primaryphoneline3`.

[1]: tools.ietf.org/html/rfc6901

Returns:



7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7301

class RequestInspectionACFP < Struct.new(
  :payload_type,
  :username_field,
  :password_field,
  :email_field,
  :phone_number_fields,
  :address_fields)
  SENSITIVE = []
  include Aws::Structure
end

#username_field ⇒ Types::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`

[1]: tools.ietf.org/html/rfc6901

Returns:



7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7301

class RequestInspectionACFP < Struct.new(
  :payload_type,
  :username_field,
  :password_field,
  :email_field,
  :phone_number_fields,
  :address_fields)
  SENSITIVE = []
  include Aws::Structure
end