Programming Guides › Programming Guide for Perl › CLI Agent API Methods › User Methods › FormData Method—Sets or Retrieves HTML Forms-based Authentication Data

FormData Method—Sets or Retrieves HTML Forms-based Authentication Data

The FormData method sets or retrieves HTML forms-based authentication data. This method is used to test authentication schemes that are based on the HTML Forms Template. The formData string consists of attribute name-value pairs separated by the ampersand (&) character.

Example:

"PASSWORD=$password1&email=$username1@mycompany.com"

Syntax

The FormData method has the following format:

Netegrity::AgentUser‑>FormData([formData])

Parameters

The FormData method accepts the following parameter:

formData (string)

(Optional) Specifies the HTML forms-based authentication data to set.

Return Value

The FormData method returns one of the following values:

• authentication_data

  Specifies the new or existing HTML forms-based authentication data.

• undef

  Specifies that the method failed.