Interface GetWebSocketAuthHeadersOptions

Options for generating WebSocket authentication headers.

interface GetWebSocketAuthHeadersOptions {
    apiKeyId: string;
    apiKeySecret: string;
    audience?: string[];
    expiresIn?: number;
    source?: string;
    sourceVersion?: string;
}

Properties

apiKeyId apiKeySecret audience? expiresIn? source? sourceVersion?

Properties

apiKeyId

apiKeyId: string

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

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))

Optionalaudience

audience?: string[]

Optional audience claim for the JWT

OptionalexpiresIn

expiresIn?: number

Optional expiration time in seconds (defaults to 120)

Optionalsource

source?: string

The source identifier for the request

OptionalsourceVersion

sourceVersion?: string

The version of the source making the request

Settings

Member Visibility

On This Page

Properties