Interface GetAuthHeadersOptions

Options for generating authentication headers for API requests.

interface GetAuthHeadersOptions {
    apiKeyId: string;
    apiKeySecret: string;
    expiresIn?: number;
    requestBody?: unknown;
    requestHost: string;
    requestMethod: string;
    requestPath: string;
    source?: string;
    sourceVersion?: string;
    walletSecret?: string;
}

Properties

apiKeyId apiKeySecret expiresIn? requestBody? requestHost requestMethod requestPath source? sourceVersion? walletSecret?

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

OptionalexpiresIn

expiresIn?: number

Optional expiration time in seconds (defaults to 120)

OptionalrequestBody

requestBody?: unknown

Optional request body data

requestHost

requestHost: string

The host for the request (e.g. 'api.cdp.coinbase.com')

requestMethod

requestMethod: string

The HTTP method for the request (e.g. 'GET', 'POST')

requestPath

requestPath: string

The path for the request (e.g. '/platform/v1/wallets')

Optionalsource

source?: string

The source identifier for the request

OptionalsourceVersion

sourceVersion?: string

The version of the source making the request

OptionalwalletSecret

walletSecret?: string

The Wallet Secret for wallet authentication

Settings

Member Visibility

On This Page

Properties