otrs -> rel-6_0 API documentation

NAME

Kernel::GenericInterface::Operation::Session::Common - Base class for Session Operations

PUBLIC INTERFACE

CreateSessionID()

performs user authentication and return a new SessionID value

my $SessionID = $CommonObject->CreateSessionID(
    Data {
        UserLogin         => 'Agent1',
        CustomerUserLogin => 'Customer1',       # optional, provide UserLogin or
                                                #   CustomerUserLogin
        Password          => 'some password',   # plain text password
    }
);

Returns undef on failure or

$SessionID = 'AValidSessionIDValue';         # the new session id value

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.