Skip to main content

​
Interfaces

​
GetWebSocketAuthHeadersOptions

Defined in: utils/ws.ts:11 Options for generating WebSocket authentication headers.

​
Properties

apiKeyId
apiKeyId: string;
Defined in: utils/ws.ts:19 The API key ID Examples: ‘xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’ ‘organizations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/apiKeys/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’
apiKeySecret
apiKeySecret: string;
Defined in: utils/ws.ts:28 The API key secret Examples: ‘xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==’ (Edwards key (Ed25519)) ‘-----BEGIN EC PRIVATE KEY-----\n…\n…\n…==\n-----END EC PRIVATE KEY-----\n’ (EC key (ES256))
source?
optional source: string;
Defined in: utils/ws.ts:33 The source identifier for the request
sourceVersion?
optional sourceVersion: string;
Defined in: utils/ws.ts:38 The version of the source making the request
expiresIn?
optional expiresIn: number;
Defined in: utils/ws.ts:43 Optional expiration time in seconds (defaults to 120)
audience?
optional audience: string[];
Defined in: utils/ws.ts:48 Optional audience claim for the JWT

​
Functions

​
getWebSocketAuthHeaders()

function getWebSocketAuthHeaders(options: GetWebSocketAuthHeadersOptions): Promise<Record<string, string>>;
Defined in: utils/ws.ts:57 Gets authentication headers for a WebSocket connection.

​
Parameters

options
GetWebSocketAuthHeadersOptions The configuration options for generating WebSocket auth headers

​
Returns

Promise<Record<string, string>> Object containing the authentication headers
⌘I