You are viewing an offline version of MongoDB documentation. Some page features might be unavailable. To view the latest version of the page or use interactive features, visit the live page.
KeyVault.addKeyAltName()
KeyVault.addKeyAltName(UUID, keyAltName)Adds the
keyAltNameto thekeyAltNamesarray of the data encryption key withUUID.keyAltNamemust be unique among all keys in the key vault.Use the
getKeyVault()method with a partial index filter on documents withkeyAltNamesto automatically create a unique index on thekeyAltNamesfield.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
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
See also: