@opentdf/sdk
    Preparing search index...

    Type Alias CreateZTDFOptions

    CreateZTDFOptions: CreateOptions & {
        assertionConfigs?: AssertionConfig[];
        metadata?: Metadata;
        mimeType?: MimeType;
        splitPlan?: SplitStep[];
        tdfSpecVersion?: "4.2.2" | "4.3.0";
        windowSize?: number;
        wrappingKeyAlgorithm?: KasPublicKeyAlgorithm;
    }

    Options specific to the ZTDF container format.

    Type declaration

    • OptionalassertionConfigs?: AssertionConfig[]

      Configuration for bound metadata.

    • Optionalmetadata?: Metadata

      Unbound metadata (deprecated).

    • OptionalmimeType?: MimeType

      MIME type of the decrypted content. Used for display.

    • OptionalsplitPlan?: SplitStep[]

      How to split or share the data encryption key across multiple KASes.

    • OptionaltdfSpecVersion?: "4.2.2" | "4.3.0"

      TDF spec version to target.

    • OptionalwindowSize?: number

      The segment size for the content; smaller is slower, but allows faster random access. The current default is 1 MiB (2^20 bytes).

    • OptionalwrappingKeyAlgorithm?: KasPublicKeyAlgorithm

      Preferred algorithm to use for Key Access Objects.

    Settings

    Member Visibility