@@ -14,7 +14,7 @@ Overview
14
14
--------
15
15
16
16
In this guide, we show you how to authenticate with MongoDB using each
17
- **authentication mechanism** available in the MongoDB Community Edition.
17
+ **authentication mechanism** available in MongoDB Community Edition.
18
18
Authentication mechanisms are processes by which the driver and server
19
19
confirm identity and establish trust to ensure security.
20
20
@@ -110,15 +110,15 @@ see the :manual:`SCRAM </core/security-scram/>` section of the server manual.
110
110
111
111
``SCRAM-SHA-256`` is a salted challenge-response authentication mechanism
112
112
(SCRAM) that uses your username and password, encrypted with the ``SHA-256``
113
- algorithm to authenticate your user.
113
+ algorithm, to authenticate your user.
114
114
115
115
The following code snippets show how to specify the authentication mechanism,
116
116
using the following placeholders:
117
117
118
- * ``username`` - your MongoDB username
119
- * ``password`` - your MongoDB user's password
120
- * ``hostname`` - network address of your MongoDB server, accessible by your client
121
- * ``port`` - port number of your MongoDB server
118
+ * ``username`` - your MongoDB username.
119
+ * ``password`` - your MongoDB user's password.
120
+ * ``hostname`` - network address of your MongoDB server, accessible by your client.
121
+ * ``port`` - port number of your MongoDB server.
122
122
* ``authenticationDb`` - MongoDB database that contains your user's
123
123
authentication data. If you omit this parameter, the driver uses the
124
124
default value ``admin``.
@@ -161,16 +161,16 @@ mechanism:
161
161
3.0, 3.2, 3.4, and 3.6.
162
162
163
163
``SCRAM-SHA-1`` is a salted challenge-response mechanism (SCRAM) that uses your
164
- username and password, encrypted with the ``SHA-1`` algorithm to authenticate
164
+ username and password, encrypted with the ``SHA-1`` algorithm, to authenticate
165
165
your user.
166
166
167
167
The following code snippets show how to specify the authentication mechanism,
168
168
using the following placeholders:
169
169
170
- * ``username`` - your MongoDB username
171
- * ``password`` - your MongoDB user's password
172
- * ``hostname`` - network address of your MongoDB server, accessible by your client
173
- * ``port`` - port number of your MongoDB server
170
+ * ``username`` - your MongoDB username.
171
+ * ``password`` - your MongoDB user's password.
172
+ * ``hostname`` - network address of your MongoDB server, accessible by your client.
173
+ * ``port`` - port number of your MongoDB server.
174
174
* ``authenticationDb`` - MongoDB database that contains your user's
175
175
authentication data. If you omit this parameter, the driver uses the
176
176
default value ``admin``.
@@ -215,7 +215,7 @@ mechanism was deprecated starting in MongoDB 3.6 and is no longer
215
215
supported as of MongoDB 4.0.
216
216
217
217
You cannot specify this method explicitly; refer to the fallback provided
218
- by the :ref:`Default authentication mechanism <default-auth-mechanism>` to
218
+ by the :ref:`default authentication mechanism <default-auth-mechanism>` to
219
219
connect using ``MONGODB-CR``.
220
220
221
221
.. _mongodb-aws-auth-mechanism:
@@ -234,14 +234,14 @@ user.
234
234
The following code snippets show how to specify the authentication mechanism,
235
235
using the following placeholders:
236
236
237
- * ``username`` - value of your ``AWS_ACCESS_KEY_ID``
238
- * ``password`` - value your ``AWS_SECRET_ACCESS_KEY``
239
- * ``hostname`` - network address of your MongoDB server, accessible by your client
240
- * ``port`` - port number of your MongoDB server
237
+ * ``username`` - value of your ``AWS_ACCESS_KEY_ID``.
238
+ * ``password`` - value of your ``AWS_SECRET_ACCESS_KEY``.
239
+ * ``hostname`` - network address of your MongoDB server, accessible by your client.
240
+ * ``port`` - port number of your MongoDB server.
241
241
* ``authenticationDb`` - MongoDB database that contains your user's
242
242
authentication data. If you omit this parameter, the driver uses the
243
243
default value ``admin``.
244
- * ``awsSessionToken`` - value of your ``AWS_SESSION_TOKEN`` *(optional)*
244
+ * ``awsSessionToken`` - value of your ``AWS_SESSION_TOKEN``. *(optional)*
245
245
246
246
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
247
247
tab below for instructions and sample code for specifying this authentication
@@ -329,8 +329,8 @@ the subject name of the client certificate.
329
329
The following code snippets show how to specify the authentication mechanism,
330
330
using the following placeholders:
331
331
332
- * ``hostname`` - network address of your MongoDB server, accessible by your client
333
- * ``port`` - port number of your MongoDB server
332
+ * ``hostname`` - network address of your MongoDB server, accessible by your client.
333
+ * ``port`` - port number of your MongoDB server.
334
334
* ``authenticationDb`` - MongoDB database that contains your user's
335
335
authentication data. If you omit this parameter, the driver uses the
336
336
default value ``admin``.
@@ -346,7 +346,7 @@ mechanism:
346
346
347
347
To specify the ``X.509`` authentication mechanism using a connection
348
348
string, assign the ``authMechanism`` parameter the value ``MONGODB-X509``
349
- value to the ``authMechanism`` and enable TLS by assigning the ``tls``
349
+ and enable TLS by assigning the ``tls``
350
350
parameter a ``true`` value. Your code to instantiate a ``MongoClient``
351
351
should look something like this:
352
352
0 commit comments