ValidateUserCredentials

Description

Returns a String containing the HCL Compass user login name of the user profile record that is authenticated by the specified login_name and password arguments. The value returned is the name stored in the user profile record, not the login name used to authenticate the user.

Returns an empty string if the password is incorrect for the specified login name.

For LDAP authenticated configurations, this function returns an empty string if there is no HCL Compass user that is mapped to a valid LDAP login_name/password pair.

Note: This method became available in version 2003.06.14.

Syntax

VBScript


session.ValidateUserCredentials(login_name, password)

Perl


$session->ValidateUserCredentials(login_name, password);

Identifier: Description
session: The Session object representing the current access session.
login_name: A String containing the user login name.
password: A String containing the user password.
Return value: Returns a String containing the HCL Compass user login name of the user profile record that is authenticated by the specified login name and password.