Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Methods › UserPasswordState Method—Sets or Retrieves Password State Object

UserPasswordState Method—Sets or Retrieves Password State Object

The UserPasswordState method sets or retrieves the password state object for the current user. Setting a new password state object updates the object's attributes with any changes that have been made. This method also clears the password history if specified by the empty-history flag.

Syntax

The UserPasswordState method has the following format:

Netegrity::PolicyMgtUser‑>UserPasswordState([pPwState][, emptyHistoryFlag])

Parameters

The UserPasswordState method accepts the following parameters:

pPwState (PolicyMgtUserPasswordState)

(Optional) Specifies the new password state object to set.

emptyHistoryFlag (int)

(Optional) Specifies whether to clear the password history.

• value = 0 (default)

  Specifies not clearing the password history.

• value = 1

  Specifies clearing the password history.

  Note: Clearing the password history sets the last-password-change-time attribute to 0. For more information, see the method PolicyMgtUserPasswordState‑>LastPWChangeTime.

Return Value

The UserPasswordState method returns one of the following values:

• PolicyMgtUserPasswordState (object)
• undef if the call is unsuccessful