Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Directory Methods › UserLookupStart Method—Sets or Retrieves User DN Lookup Starting Point

UserLookupStart Method—Sets or Retrieves User DN Lookup Starting Point

The UserLookupStart method sets or retrieves the starting point for a user DN lookup in an LDAP directory.

Syntax

The UserLookupStart method has the following format:

Netegrity::PolicyMgtUserDir‑>UserLookupStart([lookupStart])

Parameters

The UserLookupStart method accepts the following parameter:

lookupStart (string)

(Optional) Specifies a new value for the user DN lookup starting point.

Return Value

The UserLookupStart method returns one of the following values:

• user_dn_lookup_starting_point (string)

  Specifies the new or existing user DN lookup starting point.

• undef

  Specifies that the call is unsuccessful.

Remarks

Specifying values for the user DN lookup starting point and endpoint allows users to enter part of the DN string when authenticating. In the following example, the user only needs to specify the string "JSmith" and not the whole DN string when logging in:

• DN = "uid=JSmith,ou=marketing,o=myorg.org"
• starting_point = "uid="
• endpoint = ",ou=marketing,o=myorg.org"
• login = "JSmith"