CDP SDK TypeScript - v1.31.0
    Preparing search index...

    Interface GetWebSocketAuthHeadersOptions

    Options for generating WebSocket authentication headers.

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

    Properties

    apiKeyId apiKeySecret source? sourceVersion? expiresIn? audience?

    Properties

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

    source?: string

    The source identifier for the request

    sourceVersion?: string

    The version of the source making the request

    expiresIn?: number

    Optional expiration time in seconds (defaults to 120)

    audience?: string[]

    Optional audience claim for the JWT

    Settings

    Member Visibility

    On This Page

    Properties