Package version:

Interface ClientEncryptionIncludedPath

Represents a path for encryption and its associated settings.

interface ClientEncryptionIncludedPath {
    clientEncryptionKeyId: string;
    encryptionAlgorithm: AEAD_AES_256_CBC_HMAC_SHA256;
    encryptionType: EncryptionType;
    path: string;
}

Properties

clientEncryptionKeyId: string

identifier of the client encryption key to use to encrypt the path

encryption algorithm to be used currently only AEAD_AES_256_CBC_HMAC_SHA256 algo is supported

encryptionType: EncryptionType

type of encryption to be performed (Deterministic or Randomized)

path: string

name of the path to be encrypted