CSFLE-Specific MongoClient Options
On this page
Overview
View information about the Client-Side Field Level Encryption (CSFLE)-specific
configuration options for MongoClient instances.
AutoEncryptionOpts
Pass an autoEncryptionOpts object to your MongoClient
instance to specify CSFLE-specific options.
The following table describes the structure of an
autoEncryptionOpts object:
Parameter | Type | Required | Description |
|---|---|---|---|
keyVaultClient | MongoClient | No | A If you omit the To learn more about Key Vault collections, see Key Vault Collections. |
keyVaultNamespace | String | Yes | The full namespace of the Key Vault collection. |
kmsProviders | Object | Yes | The Key Management System (KMS) used by Client-Side Field Level Encryption for managing your Customer Master Keys (CMKs). To learn more about To learn more about Customer Master Keys, see Keys and Key Vaults. |
tlsOptions | Object | No | An object that maps Key Management System provider names to TLS configuration options. To learn more about TLS options see: TLS Options. To learn more about TLS see: TLS/SSL (Transport Encryption). |
schemaMap | Object | No | An encryption schema. To learn how to construct an encryption schema, see Encryption Schemas. For complete documentation of encryption schemas, see Encryption Schemas. |
bypassAutoEncryption | Boolean | No | Specify To learn more about this option, see Automatic Decryption. |
Example
To view a code-snippet demonstrating how to use
autoEncryptionOpts to configure your
MongoClient instance, select the tab corresponding to your driver: