NAME

Kernel::System::Auth – agent authentication module.

DESCRIPTION

The authentication module for the agent interface.

PUBLIC INTERFACE

new()

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

    my $AuthObject = $Kernel::OM->Get('Kernel::System::Auth');

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 some other options. E. g. $ENV{REMOTE_USER}\n";
    }

Auth()

The authentication function.

    my $AuthValid = $AuthObject->Auth(
        User           => $User,            # (required)
        Pw             => $Pw,              # (required)
        TwoFactorToken => $TwoFactorToken,  # (optional)
        DeviceUUID     => $DeviceUUID,      # (optional)

        CheckPasswordOnly => 1,             # (optional) Check password only, skip actual auth
                                            #            default: 0
    );

    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.";