Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Directory Methods › Username Method—Sets or Retrieves Username

Username Method—Sets or Retrieves Username

The Username method sets or retrieves the username required for accessing the user directory. Set the username only if the RequireCredentials method returns the value of 1.

Syntax

The Username method has the following format:

Netegrity::PolicyMgtUserDir‑>Username([username])

Parameters

The Username method accepts the following parameters:

username (string)

(Optional) Specifies a new name for the user.

Return Value

The Username method returns one of the following values:

• user_name (string)

  Specifies the new or existing name of the user.

• undef

  Specifies that the call is unsuccessful.