Skip to content

Commit 43664d4

Browse files
authored
DOCSP-23030 addKeyAlternateName, removeKeyAlternateName, and createKey aliases (#1200)
* DOCSP-23030 addKeyAlternateName, removeKeyAlternateName, and createKey aliases * adds alias pages * method index page * cleanup * internal review feedback * removing versionadded
1 parent 0410b93 commit 43664d4

File tree

4 files changed

+101
-4
lines changed

4 files changed

+101
-4
lines changed

source/reference/method.txt

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1354,6 +1354,10 @@ Client-Side Field Level Encryption
13541354

13551355
- Returns the key vault object for the current MongoDB connection.
13561356

1357+
* - :method:`KeyVault.createDataKey()`
1358+
1359+
- An alias for :method:`KeyVault.createKey()`.
1360+
13571361
* - :method:`KeyVault.createKey()`
13581362

13591363
- Creates a data encryption key for use with client-side field level encryption.
@@ -1364,23 +1368,31 @@ Client-Side Field Level Encryption
13641368

13651369
* - :method:`KeyVault.getKey()`
13661370

1367-
- Retreives the specified data encryption key from the key vault.
1371+
- Retrieves the specified data encryption key from the key vault.
13681372

13691373
* - :method:`KeyVault.getKeys()`
13701374

13711375
- Retrieves all keys in the key vault.
13721376

13731377
* - :method:`KeyVault.addKeyAlternateName()`
13741378

1375-
- Associates a key alternative name to the specified data encryption key.
1379+
- Associates a key's alternative name to the specified data encryption key.
1380+
1381+
* - :method:`KeyVault.addKeyAltName()`
1382+
1383+
- An alias for :method:`KeyVault.addKeyAlternateName()`.
13761384

13771385
* - :method:`KeyVault.removeKeyAlternateName()`
13781386

1379-
- Removes a key alternative name from the specified data encryption key.
1387+
- Removes a key's alternative name from the specified data encryption key.
1388+
1389+
* - :method:`KeyVault.removeKeyAltName()`
1390+
1391+
- An alias for :method:`KeyVault.removeKeyAlternateName()`.
13801392

13811393
* - :method:`KeyVault.getKeyByAltName()`
13821394

1383-
- Retrieves keys with the specified key alternative name.
1395+
- Retrieves a key with the specified key alternative name.
13841396

13851397
* - :method:`getClientEncryption()`
13861398

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _keyvault-addkeyalt-method:
2+
3+
========================
4+
KeyVault.addKeyAltName()
5+
========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
.. method:: KeyVault.addKeyAltName(UUID, keyAltName)
16+
17+
Adds the ``keyAltName`` to the ``keyAltNames`` array of the data
18+
encryption key with ``UUID``.
19+
20+
``keyAltName`` *must* be unique among all keys in the key vault.
21+
22+
Use the :method:`getKeyVault()` method with a :ref:`partial index
23+
<index-type-partial>` filter on documents with ``keyAltNames`` to
24+
automatically create a :ref:`unique index <index-type-unique>` on
25+
the ``keyAltNames`` field.
26+
27+
This method is an alias for
28+
:method:`~KeyVault.addKeyAlternateName()`.
29+
30+
.. seealso::
31+
32+
:method:`~KeyVault.addKeyAlternateName()`.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _keyvault-createdatakey-method:
2+
3+
========================
4+
KeyVault.createDataKey()
5+
========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
.. method:: KeyVault.createDataKey(keyManagementService, customerMasterKey, ["keyAltName"])
16+
17+
Adds a data encryption key to the key vault associated to the
18+
database connection. :ref:`Client-side field level encryption
19+
<csfle-guide-intro>` uses data encryption keys
20+
for supporting encryption and decryption of field values.
21+
22+
This method is an alias for
23+
:method:`~KeyVault.createDataKey()`.
24+
25+
.. seealso::
26+
27+
:method:`~KeyVault.createDataKey()`.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _keyvault-removekeyaltname-method:
2+
3+
===========================
4+
KeyVault.removeKeyAltName()
5+
===========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
.. method:: KeyVault.removeKeyAltName(UUID, keyAltName)
16+
17+
Removes the specified ``keyAltName`` from the data encryption key
18+
with the specified ``UUID``. The data encryption key must exist in
19+
the key vault associated with the database connection.
20+
21+
This method is an alias for
22+
:method:`~KeyVault.removeKeyAlternateName()`.
23+
24+
.. seealso::
25+
26+
:method:`~KeyVault.removeKeyAlternateName()`.

0 commit comments

Comments
 (0)