Skip to content

Commit 7c55fc8

Browse files
committed
enterprise standardize
1 parent f77d104 commit 7c55fc8

File tree

1 file changed

+17
-45
lines changed

1 file changed

+17
-45
lines changed

source/security/enterprise-auth.txt

Lines changed: 17 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -35,49 +35,10 @@ Enterprise Edition:
3535
For more information on establishing a connection to your MongoDB cluster, read our
3636
:ref:`Connection Guide <kotlin-sync-connect>`.
3737

38-
39-
Specify an Authentication Mechanism
40-
-----------------------------------
41-
42-
You can specify your authentication mechanism and credentials when connecting
43-
to MongoDB using either of the following:
44-
45-
- A connection string
46-
- A ``MongoCredential`` factory method
47-
48-
A **connection string** (also known as a **connection URI**) specifies how to
49-
connect and authenticate to your MongoDB cluster.
50-
51-
To authenticate using a connection string, include your settings in your
52-
connection string and pass it to the ``MongoClient.create()`` method to
53-
instantiate your ``MongoClient``. The :guilabel:`Connection String`
54-
tab in each section provides the syntax for authenticating using a
55-
**connection string**.
56-
57-
Alternatively, you can use the ``MongoCredential`` class to specify your
58-
authentication details. The ``MongoCredential`` class contains static factory
59-
methods that construct instances containing your authentication mechanism and
60-
credentials. When you use the ``MongoCredential`` helper class, you need
61-
to use the ``MongoClientSettings.Builder`` class to configure your
62-
connection settings when constructing your ``MongoClient``. The
63-
:guilabel:`MongoCredential` tab in each section provides the syntax for
64-
authenticating using a ``MongoCredential``.
65-
66-
For more information on these classes and methods, refer to the following API
67-
documentation:
68-
69-
- `MongoClient.create() <{+api+}/com.mongodb.kotlin.client/-mongo-client/-factory/index.html>`__
70-
- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__
71-
- `MongoClientSettings.Builder <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
72-
- `MongoCredential <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__
73-
74-
Mechanisms
75-
----------
76-
7738
.. _gssapi-auth-mechanism:
7839

7940
Kerberos (GSSAPI)
80-
~~~~~~~~~~~~~~~~~
41+
-----------------
8142

8243
The Generic Security Services API (``GSSAPI``) authentication mechanism
8344
allows the user to authenticate to a Kerberos service using the user's
@@ -272,7 +233,7 @@ to improve performance.
272233
.. _plain-auth-mechanism:
273234

274235
LDAP (PLAIN)
275-
~~~~~~~~~~~~
236+
------------
276237

277238
*Available in MongoDB Enterprise Edition 3.4 and later.*
278239

@@ -341,7 +302,7 @@ mechanism:
341302
.. _kotlin-oidc:
342303

343304
MONGODB-OIDC
344-
~~~~~~~~~~~~
305+
------------
345306

346307
.. important::
347308

@@ -359,7 +320,7 @@ in the MongoDB Server manual.
359320
.. _kotlin-mongodb-oidc-azure-imds:
360321

361322
Azure IMDS
362-
++++++++++
323+
~~~~~~~~~~
363324

364325
If your application runs on an Azure VM, or otherwise uses the
365326
`Azure Instance Metadata Service <https://learn.microsoft.com/en-us/azure/virtual-machines/instance-metadata-service>`__
@@ -411,7 +372,7 @@ see the corresponding syntax.
411372
.. _kotlin-mongodb-oidc-gcp-imds:
412373

413374
GCP IMDS
414-
++++++++
375+
~~~~~~~~
415376

416377
If your application runs on a Google Compute Engine VM, or otherwise uses the
417378
`GCP Instance Metadata Service <https://cloud.google.com/compute/docs/metadata/querying-metadata>`__,
@@ -459,7 +420,7 @@ see the corresponding syntax.
459420
:end-before: end-oidc-gcp-mongo-cred
460421

461422
Custom Callback
462-
+++++++++++++++
423+
~~~~~~~~~~~~~~~
463424

464425
The {+driver-short+} doesn't offer built-in support for all platforms, including
465426
Azure Functions and Azure Kubernetes Service (AKS). Instead, you
@@ -485,3 +446,14 @@ named ``"access-token.dat"`` in the local file system:
485446
:dedent:
486447
:start-after: start-oidc-custom-callback-ex
487448
:end-before: end-oidc-custom-callback-ex
449+
450+
API Documentation
451+
-----------------
452+
453+
To learn more about the classes and methods for authenticating your application
454+
with {+driver-short+}, see the following API documentation:
455+
456+
- `MongoClient.create() <{+api+}/com.mongodb.kotlin.client/-mongo-client/-factory/index.html>`__
457+
- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__
458+
- `MongoClientSettings.Builder <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
459+
- `MongoCredential <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__

0 commit comments

Comments
 (0)