Kernel::System::BrowserTrust

NAME

Kernel::System::BrowserTrust

DESCRIPTION

Manages trusted browsers.

PUBLIC INTERFACE

BrowserTrustAdd()

Adds a UUID fingerprint to the trusted browsers

    my $BrowserTrustID = $BrowserTrustObject->BrowserTrustAdd(
        UserType        => 'agent',                                 # (required) User type, supported values: agent|customer
        UserID          => 2,                                       # (required) User ID (agent users) or login name (customer users)
        UUIDFingerprint => 'ba77134f-a136-4702-bd83-d3dfea0ce1f7',  # (required) UUID fingerprint value (v4 or similar)
    );

Returns ID value of added record if successful.

BrowserTrustGet()

Returns a specific record from the trusted browsers.

    my %BrowserTrust = $BrowserTrustObject->BrowserTrustGet(
        BrowserTrustID  => 1,                                       # (required) Trusted browser record ID
                                                                    # or
        UserType        => 'agent',                                 # (required) User type, supported values: agent|customer
        UserID          => 2,                                       # (required) User ID (agent users) or login name (customer users)
        UUIDFingerprint => 'ba77134f-a136-4702-bd83-d3dfea0ce1f7',  # (optional) UUID fingerprint value (v4 or similar)
    );

Returns trusted browser data:

    %BrowserTrust = (
        BrowserTrustID  => 1,
        UserType        => 'agent',
        UserID          => 2,
        UUIDFingerprint => 'ba77134f-a136-4702-bd83-d3dfea0ce1f7',
        CreateTime      => '2019-01-30 11:53:48',
    );

BrowserTrustCleanupForUser()

Cleans up trusted browsers for a specific user.

    my $Success = $BrowserTrustObject->BrowserTrustCleanupForUser(
        UserType        => 'agent',                                 # (required) User type, supported values: agent|customer
        UserID          => 2,                                       # (required) User ID (agent users) or login name (customer users)
        UUIDFingerprint => 'ba77134f-a136-4702-bd83-d3dfea0ce1f7',  # (optional) UUID fingerprint value (v4 or similar)
    );

Returns 1 if trusted browsers for the user were cleaned up successfully.

BrowserTrustCleanupExpired()

Cleans up all expired trusted browsers.

    my $Success = $BrowserTrustObject->BrowserTrustCleanupExpired();

Returns 1 if expired trusted browsers were cleaned up successfully.

Scroll to Top