Skip to content

DOCSP-13972 clarify keyID array of single UUID #5010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 26, 2021
Merged

DOCSP-13972 clarify keyID array of single UUID #5010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions source/reference/security-client-side-automatic-json-schema.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,13 @@ and ``taxid-short`` fields for write or read operations to the

.. autoencryptkeyword:: encrypt.keyId

*Array of UUID*
*Array of single UUID*

The UUID of the data encryption key to use for encrypting field
values. Specify *one* string inside the array. The UUID is a BSON
`binary data <http://bsonspec.org/spec.html>`_ element of subtype
``4``.
values. The UUID is a BSON `binary data
<http://bsonspec.org/spec.html>`_ element of subtype ``4``.

Specify *one* string inside the array.

If omitted, :ref:`mongocryptd` checks the full tree of parent
fields for the nearest
Expand Down Expand Up @@ -327,15 +328,16 @@ and ``taxid-short`` fields for write or read operations to the

*Array of single UUID*

The UUID of a data encryption key. If an
:autoencryptkeyword:`encrypt` object is missing the
The UUID of a data encryption key. The UUID is a BSON `binary data
<http://bsonspec.org/spec.html>`_ element of subtype ``4``.

Specify *one* string inside the array.

If an :autoencryptkeyword:`encrypt` object is missing the
:autoencryptkeyword:`~encrypt.keyId` field, ``mongocryptd``
searches the entire tree of parent objects to locate
an :autoencryptkeyword:`encryptMetadata` object that
specifies :autoencryptkeyword:`encryptMetadata.keyId`.

The UUID is a BSON `binary data <http://bsonspec.org/spec.html>`_
element of subtype ``4``.

The data encryption key *must* exist in the key vault specified as
part of the auto encryption :ref:`configuration options
Expand Down