exportPrivateKey()

Exports a private key as an encrypted bundle.

This function exports the specified private key as an encrypted bundle, suitable for backup or transfer.
The exported bundle contains the private key’s key material, encrypted to the provided target public key.
If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown.
If an organizationId is provided, the private key will be exported under that sub-organization; otherwise, the current session’s organizationId is used.
Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

Package: core

Defined in: core.ts:3240

params

object

required

Show params details

params.organizationId

string

organization ID to export the private key under a specific sub

params.privateKeyId

string

required

ID of the private key to export.

params.stampWith

StamperType

parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.targetPublicKey

string

required

public key to encrypt the bundle to (required).

A successful response returns the following fields:

returns

string

required

A promise that resolves to an ExportBundle object containing the encrypted private key and metadata.