Docs Menu
Docs Home
/
MongoDB Manual
/
Reference
/
mongosh Methods
/
Client-Side Field Level Encryption

KeyVault.addKeyAltName()

On this page

  • Compatibility
KeyVault.addKeyAltName(UUID, keyAltName)

Adds the keyAltName to the keyAltNames array of the data encryption key with UUID.

keyAltName must be unique among all keys in the key vault.

Use the getKeyVault() method with a partial index filter on documents with keyAltNames to automatically create a unique index on the keyAltNames field.

This method is an alias for addKeyAlternateName().

Compatibility

This command is available in deployments hosted in the following environments:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Tip

See also:

addKeyAlternateName().

Back

getKeyVault

Next

KeyVault.addKeyAlternateName

On this page