edits, build errors

Author: norareidy

snooty.toml

@@ -12,7 +12,8 @@ toc_landing_pages = [
     "/crud",
     "/crud/builders",
     "/data-formats",
-    "/api-documentation"
+    "/api-documentation",
+    "/security/auth"
 ]
 
 sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

source/connection.txt

@@ -38,4 +38,4 @@ sections:
 - :atlas:`Connect to MongoDB Atlas from AWS Lambda </manage-connections-aws-lambda/>`
 
 For information about authenticating with a MongoDB instance,
-see :ref:`<authentication-mechanisms>` and :ref:`<enterprise-authentication-mechanisms>`.
+see the :ref:`<java-authentication-mechanisms>` section.

source/faq.txt

@@ -185,9 +185,8 @@ check the following items in your code:
 
 - The credentials for the authentication mechanism that you specified are
   correct. To learn how to specify your credentials, see the
-  :ref:`authentication-mechanisms` and :ref:`enterprise-authentication-mechanisms`
-  guides.
-
+  :ref:`java-authentication-mechanisms` section.
+  
 - The name of the authentication database that you specified is correct. To
   learn how to set up the users and roles for your MongoDB deployment, see
   `Manage Users and Roles <https://www.mongodb.com/docs/manual/tutorial/manage-users-and-roles/>`__

source/security/auth/aws-iam.txt

@@ -56,8 +56,8 @@ provide your AWS IAM credentials.
 
 .. _java-mongodb-aws-sdk:
 
-AWS SDK for Java
-~~~~~~~~~~~~~~~~
+Use AWS SDK for Java
+~~~~~~~~~~~~~~~~~~~~
 
 .. important::
 
@@ -72,11 +72,11 @@ offers the following features:
 - Credential provider management for use with the `Elastic Kubernetes Service <https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html>`__.
 
 To use the AWS SDK for Java for ``MONGODB-AWS`` authentication, you must
-perform the following:
+perform the following actions:
 
 1. Specify the authentication mechanism
 #. Add the SDK as a dependency to your project
-#. Supply your credentials using one of the methods in the credential
+#. Supply your credentials by using one of the methods in the credential
    provider chain
 
 To specify the authentication mechanism by using a ``MongoCredential``,
@@ -89,7 +89,7 @@ in the following example:
    :dedent:
    :start-after: start mechOnlyMongoCredential
    :end-before: end mechOnlyMongoCredential
-   :emphasize-lines: 1,7
+   :emphasize-lines: 1,8
 
 To specify the authentication mechanism in the connection string, add
 it as a parameter as shown in the following example:
@@ -110,10 +110,10 @@ AWS documentation for the version you need:
 
 .. note::
 
-   For the AWS SDK for Java v2, the Java driver currently tests using the
+   For the AWS SDK for Java v2, the Java driver tests using the
    ``software.amazon.awssdk:auth:2.18.9`` dependency.
 
-   For the AWS SDK for Java v1, the Java driver currently tests using the
+   For the AWS SDK for Java v1, the Java driver tests using the
    ``com.amazonaws:aws-java-sdk-core:1.12.337`` dependency.
 
 To supply your credentials, see the following AWS documentation for the
@@ -142,21 +142,21 @@ version you need:
 
 .. _java-mongodb-aws-env-variables:
 
-Specify Your Credentials in the Environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use Environment Variables
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can provide your AWS IAM credentials by instructing the driver to
 use the ``MONGODB-AWS`` authentication mechanism and by setting the
 appropriate environment variables.
 
 To use the environment variables to supply your credentials, you must perform
-the following:
+the following actions:
 
 1. Specify the authentication mechanism
 #. Add the appropriate environment variables
 
 You can specify the authentication mechanism by using a ``MongoCredential``
-or on the connection string.
+or in the connection string.
 
 To specify the authentication mechanism by using a ``MongoCredential``,
 use the ``MongoCredential.createAwsCredential()`` factory method and add the
@@ -168,7 +168,7 @@ example:
    :dedent:
    :start-after: start mechOnlyMongoCredential
    :end-before: end mechOnlyMongoCredential
-   :emphasize-lines: 1,7
+   :emphasize-lines: 1,8
 
 To specify the authentication mechanism in the connection string, add it as a
 parameter as shown in the following example:
@@ -179,8 +179,8 @@ parameter as shown in the following example:
    :start-after: start mechOnlyConnectionString
    :end-before: end mechOnlyConnectionString
 
-The next examples show how to provide your credentials by setting environment
-variables for the following types of authentication:
+You can also set environment variables to enable the following types of
+authentication:
 
 - Programmatic access keys
 - Web identity provider
@@ -230,21 +230,22 @@ of from environment variables.
 
 .. _java-mongodb-aws-mongoclient-configuration:
 
-Specify Your Credentials in a MongoCredential
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use a MongoCredential Instance
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can supply your AWS IAM credentials to a ``MongoClient`` by using a
 ``MongoCredential`` instance. To construct the ``MongoCredential`` instance
-for ``MONGODB-AWS`` authentication,  use the `createAwsCredential() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createAwsCredential(java.lang.String,char%5B%5D)>`__
+for ``MONGODB-AWS`` authentication,  use the ``createAwsCredential()``
 factory method.
 
 You can supply only programmatic access keys to the
 ``MongoCredential.createAwsCredential()`` method. If you must supply ECS
-or EC2 container credentials, use the instructions in
-:ref:`<java-mongodb-aws-env-variables>` or :ref:`<java-mongodb-aws-sdk>`.
+or EC2 container credentials, use the instructions in the
+:ref:`<java-mongodb-aws-env-variables>` or :ref:`<java-mongodb-aws-sdk>`
+sections.
 
 To use the ``MongoCredential`` for ``MONGODB-AWS`` authentication, you
-must perform the following:
+must perform the following actions:
 
 1. Specify the authentication mechanism
 #. Supply the credentials
@@ -259,7 +260,7 @@ in the following example:
    :dedent:
    :start-after: start mongoCredential
    :end-before: end mongoCredential
-   :emphasize-lines: 1
+   :emphasize-lines: 1,8
 
 If you must specify an AWS session token, pass it to the
 `withMechanismProperty() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#withMechanismProperty(java.lang.String,T)>`__
@@ -270,7 +271,7 @@ method as shown in the following example:
    :dedent:
    :start-after: start mongoCredentialSessionTokenCredential
    :end-before: end mongoCredentialSessionTokenCredential
-   :emphasize-lines: 1,7
+   :emphasize-lines: 1,8
 
 To refresh your credentials, you can declare a ``Supplier`` lambda expression
 that returns new credentials as shown in the following example:
@@ -280,11 +281,11 @@ that returns new credentials as shown in the following example:
    :dedent:
    :start-after: start refreshCredentials
    :end-before: end refreshCredentials
-   :emphasize-lines: 4-5,8-9
+   :emphasize-lines: 1-5,9
 
 .. note::
 
-   If you must provide AWS IAM credentials in a connection string, refer to
+   If you must provide AWS IAM credentials in a connection string, see
    v4.7 or earlier of the {+driver-short+} documentation. 
 
 API Documentation

source/security/auth/kerberos.txt

@@ -29,7 +29,7 @@ Code Placeholders
 
 The code examples on this page use the following placeholders:
 
-- ``<username>``: Your :wikipedia:`URL-encoded <Percent-encoding>` principal name. For
+- ``<db_username>``: Your :wikipedia:`URL-encoded <Percent-encoding>` principal name. For
   example: ``"username%40REALM.ME"``
 - ``<hostname>``: The network address of your MongoDB deployment.
 - ``<port>``: The port number of your MongoDB deployment. If you omit this parameter,
@@ -77,8 +77,7 @@ mechanism:
       .. include:: /includes/fundamentals/code-snippets/auth-credentials-gssapi.rst
 
 
-In order to acquire a
-`Kerberos ticket <https://docs.oracle.com/en/java/javase/11/docs/api/java.security.jgss/javax/security/auth/kerberos/KerberosTicket.html>`__,
+To acquire a `Kerberos ticket <https://docs.oracle.com/en/java/javase/11/docs/api/java.security.jgss/javax/security/auth/kerberos/KerberosTicket.html>`__,
 the GSSAPI Java libraries require you to specify the realm and Key Distribution
 Center (KDC) system properties. See the sample settings in the following example:
 
@@ -90,7 +89,7 @@ Center (KDC) system properties. See the sample settings in the following example
 Additional Properties
 ~~~~~~~~~~~~~~~~~~~~~
 
-You might need to specify one or more of the following additional
+You might need to specify one or more of the followingx
 ``MongoCredential`` mechanism properties depending on your Kerberos setup:
 
 - ``SERVICE_NAME``
@@ -210,4 +209,4 @@ page, see the following API documentation:
 - `MongoClient <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html>`__
 - `MongoCredential <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__
 - `MongoCredential.createGSSAPICredential() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createGSSAPICredential(java.lang.String)>`__
-- `MongoCredential.withMechanismProperty() <{+api+}/apidocs/mongodb-driver-core/com/mongodbMongoCredential.html#withMechanismProperty(java.lang.String,T)>`__
+- `MongoCredential.withMechanismProperty() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#withMechanismProperty(java.lang.String,T)>`__

source/security/auth/ldap.txt

@@ -34,8 +34,8 @@ Code Placeholders
 
 The code examples on this page use the following placeholders:
 
-- ``<username>``: Your LDAP username.
-- ``<password>``: Your LDAP password.
+- ``<db_username>``: Your LDAP username.
+- ``<db_password>``: Your LDAP password.
 - ``<hostname>``: The network address of your MongoDB deployment.
 - ``<port>``: The port number of your MongoDB deployment. If you omit this parameter,
   the driver uses the default port number (``27017``). You don't need to specify a port
@@ -55,7 +55,7 @@ mechanism:
    .. tab::
       :tabid: Connection String
 
-      To specify the LDAP (PLAIN) authentication mechanism using a connection
+      To specify the LDAP (PLAIN) authentication mechanism by using a connection
       string, perform the following actions:
 
       - Assign the ``authMechanism`` URL parameter to the value ``PLAIN``
@@ -75,7 +75,7 @@ mechanism:
    .. tab::
       :tabid: MongoCredential
 
-      To specify the LDAP (PLAIN) authentication mechanism using the
+      To specify the LDAP (PLAIN) authentication mechanism by using the
       ``MongoCredential`` class, use the ``createPlainCredential()``
       method. The code to instantiate a ``MongoClient`` resembles the following:
 

source/security/auth/oidc.txt

@@ -34,10 +34,23 @@ Enterprise Advanced, and only when authenticating to MongoDB v7.0 or later.
    in the Atlas documentation.
 
    For more information about using OIDC authentication with MongoDB, see
-   :manual:`OpenID Connect Authentication </core/security-oidc/>` and
-   :manual:`MongoDB Server Parameters </reference/parameters/#mongodb-parameter-param.oidcIdentityProviders>`
+   :manual:`Authentication and Authorization with OIDC/OAuth 2.0 </core/security-oidc/>` and
+   :manual:`oidcIdentityProviders </reference/parameters/#mongodb-parameter-param.oidcIdentityProviders>`
    in the {+mdb-server+} manual.
 
+Code Placeholders 
+~~~~~~~~~~~~~~~~~
+
+The code examples on this page use the following placeholders:
+
+- ``<db_username>``: The MongoDB username of the user to authenticate.
+- ``<hostname>``: The network address of your MongoDB deployment.
+- ``<port>``: The port number of your MongoDB deployment. If you omit this parameter,
+  the driver uses the default port number (``27017``). You don't need a port number
+  when connecting to a MongoDB Atlas cluster.
+
+To use the code examples, replace these placeholders with your own values.
+
 Specify OIDC Authentication
 ---------------------------
 
@@ -85,9 +98,7 @@ see the corresponding syntax:
    .. tab:: MongoCredential
       :tabid: mongodb-azure-mongo-credential
 
-      Replace the ``<db_username>`` placeholder with the client ID or application ID of the
-      Azure managed identity or enterprise application. Replace the ``<audience>``
-      placeholder with the value of the
+      Replace the ``<audience>`` placeholder with the value of the
       ``audience`` server parameter configured on your MongoDB deployment.
 
       .. code-block:: java
@@ -208,4 +219,4 @@ page, see the following API documentation:
 - `MongoClient <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html>`__
 - `MongoCredential <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__
 - `MongoCredential.createOidcCredential() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createOidcCredential(java.lang.String)>`__
-- `MongoCredential.withMechanismProperty() <{+api+}/apidocs/mongodb-driver-core/com/mongodbMongoCredential.html#withMechanismProperty(java.lang.String,T)>`__
+- `MongoCredential.withMechanismProperty() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#withMechanismProperty(java.lang.String,T)>`__

source/security/auth/scram.txt

@@ -69,7 +69,7 @@ tab below for instructions and sample code for the corresponding syntax:
    .. tab::
       :tabid: Connection String
 
-      To specify the default authentication mechanism using a connection
+      To specify the default authentication mechanism by using a connection
       string, omit the mechanism. The code to instantiate a ``MongoClient``
       resembles the following:
 
@@ -80,7 +80,7 @@ tab below for instructions and sample code for the corresponding syntax:
    .. tab::
       :tabid: MongoCredential
 
-      To specify the default authentication mechanism using the
+      To specify the default authentication mechanism by using the
       ``MongoCredential`` class, use the ``createCredential()`` method. The
       code to instantiate a ``MongoClient`` resembles the following:
 
@@ -109,7 +109,7 @@ mechanism:
    .. tab::
       :tabid: Connection String
 
-      To specify the ``SCRAM-SHA-256`` authentication mechanism using a
+      To specify the ``SCRAM-SHA-256`` authentication mechanism by using a
       connection string, assign the ``authMechanism`` parameter the value
       ``SCRAM-SHA-256`` in your connection string. The code to instantiate
       a ``MongoClient`` resembles the following:
@@ -121,7 +121,7 @@ mechanism:
    .. tab::
       :tabid: MongoCredential
 
-      To specify the default authentication mechanism using the
+      To specify the ``SCRAM-SHA-256`` authentication mechanism by using the
       ``MongoCredential`` class, use the ``createScramSha256Credential()``
       method. The code to instantiate a ``MongoClient`` resembles
       the following:
@@ -136,7 +136,7 @@ username and password, encrypted with the ``SHA-1`` algorithm, to authenticate
 your user.
 
 ``SCRAM-SHA-1`` is the default authentication method for MongoDB versions
-3.0, 3.2, 3.4, and 3.6, but this code example shows how to explicitly use this
+earlier than 4.0, but this code example shows how to explicitly use this
 mechanism. Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
 tab for instructions and sample code for specifying this authentication
 mechanism:
@@ -146,7 +146,7 @@ mechanism:
    .. tab::
       :tabid: Connection String
 
-      To specify the ``SCRAM-SHA-1`` authentication mechanism using a
+      To specify the ``SCRAM-SHA-1`` authentication mechanism by using a
       connection string, assign the ``authMechanism`` parameter the value
       ``SCRAM-SHA-1`` in your connection string. The code to instantiate
       a ``MongoClient`` resembles the following:
@@ -158,7 +158,7 @@ mechanism:
    .. tab::
       :tabid: MongoCredential
 
-      To specify the default authentication mechanism using the
+      To specify the ``SCRAM-SHA-1`` authentication mechanism by using the
       ``MongoCredential`` class, use the ``createScramSha1Credential()``
       method. The code to instantiate a ``MongoClient`` resembles the following:
 

source/security/auth/x509.txt

@@ -31,7 +31,8 @@ Enterprise Advanced, and MongoDB Community Edition.
    see :ref:`TLS/SSL <tls-ssl>`.
 
    For more information about X.509 certificates, see
-   :ref:`X.509 <x509-client-authentication>` in the {+mdb-server+} manual.
+   :manual:`Use x.509 Certificates to Authenticate Clients on Self-Managed Deployments
+   </tutorial/configure-x509-client-authentication/>` in the {+mdb-server+} manual.
 
 Code Placeholders 
 ~~~~~~~~~~~~~~~~~
@@ -60,11 +61,10 @@ mechanism:
    .. tab::
       :tabid: Connection String
 
-      To specify the ``X.509`` authentication mechanism using a connection
-      string, assign the ``authMechanism`` parameter the value ``MONGODB-X509``
-      and enable TLS by assigning the ``tls``
-      parameter a ``true`` value. The code to instantiate a ``MongoClient``
-      resembles the following:
+      To specify the ``X.509`` authentication mechanism by using a connection
+      string, assign the ``authMechanism`` parameter to ``MONGODB-X509``
+      and enable TLS by assigning the ``tls`` parameter to ``true``. The code
+      to instantiate a ``MongoClient`` resembles the following:
 
       .. code-block:: java
 
@@ -73,7 +73,7 @@ mechanism:
    .. tab::
       :tabid: MongoCredential
 
-      To specify the ``X.509`` authentication mechanism using the
+      To specify the ``X.509`` authentication mechanism by using the
       ``MongoCredential`` class, use the ``createMongoX509Credential()``
       method. Also, enable TLS by calling the
       `applyToSslSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`__