Type Alias WebSocketAuthParams

Websocket auth parameters to use when setting up a websocket based on a host config

type WebSocketAuthParams = {
    headers?: Record<string, string>;
    pfxOptions?: PfxAuthOptions;
    queryParams?: Record<string, string>;
}

Properties

headers?: Record<string, string>

Headers added to the websocket connection. Headers is only applied in NodeJS environments and NOT in browsers

Auth options for the websocket connection. These options are only applicable for nodeJS applications connecting to Qlik Sense Enterprise on Windows

queryParams?: Record<string, string>

The query parameters to add to the websocket URL