otrs -> rel-6_0 API documentation

NAME

Kernel::System::CustomerAuth - customer authentication module.

DESCRIPTION

The authentication module for the customer interface.

PUBLIC INTERFACE

new()

Don't use the constructor directly, use the ObjectManager instead:

my $CustomerAuthObject = $Kernel::OM->Get('Kernel::System::CustomerAuth');

GetOption()

Get module options. Currently there is just one option, PreAuth.

if ($AuthObject->GetOption(What => 'PreAuth')) {
    print "No login screen is needed. Authentication is based on other options. E. g. $ENV{REMOTE_USER}\n";
}

Auth()

The authentication function.

if ($AuthObject->Auth(User => $User, Pw => $Pw)) {
    print "Auth ok!\n";
}
else {
    print "Auth invalid!\n";
}

GetLastErrorMessage()

Retrieve $Self->{LastErrorMessage} content.

my $AuthErrorMessage = $AuthObject->GetLastErrorMessage();

Result:

    $AuthErrorMessage = "An error string message.";

TERMS AND CONDITIONS

This software is part of the OTRS project (https://otrs.org/).

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (GPL). If you did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.