Programming Guides › Programming Guide for Perl › CLI Agent API Methods › User Methods › CustomData Method—Sets or Retrieves Custom Authentication Data

CustomData Method—Sets or Retrieves Custom Authentication Data

The CustomData method sets or retrieves custom authentication data. This method is used to test authentication schemes that are based on the Custom Template. The format and content of custom authentication data are customer-defined according to the requirements of each Web site.

Syntax

The CustomData method has the following format:

Netegrity::AgentUser‑>CustomData([customData, length])

Parameters

The CustomData method accepts the following parameters:

customData (string)

(Optional) Specifies the custom authentication data to set.

length (int)

(Optional) Specifies the length of the custom authentication data.

Return Value

The CustomData method returns one of the following values:

• ($String, $Length)

  Specifies the new or existing custom authentication data and length.

• undef

  Specifies that the method failed.