From c9536e3385d9ff882c9081d6623674d8c1b7a7d4 Mon Sep 17 00:00:00 2001 From: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Date: Thu, 24 Apr 2025 19:16:09 -0400 Subject: [PATCH] DOCSP-48713 Update non-MongoDB credentials (#676) * DOCSP-48713 Update non-MongoDB credentials * edits to gssapi (cherry picked from commit ba0d907290bebe9c4eafd2ec5fc68dff33053f7e) --- .../code-snippets/auth-credentials-gssapi-properties.rst | 2 +- .../code-snippets/auth-credentials-gssapi-subject-key.rst | 2 +- .../code-snippets/auth-credentials-gssapi-ticket-cache.rst | 2 +- .../fundamentals/code-snippets/auth-credentials-gssapi.rst | 2 +- .../fundamentals/code-snippets/auth-credentials-ldap.rst | 2 +- source/security/auth/kerberos.txt | 6 +++--- source/security/auth/ldap.txt | 6 +++--- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-properties.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-properties.rst index f4ec395ce..44fa2e0de 100644 --- a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-properties.rst +++ b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-properties.rst @@ -1,5 +1,5 @@ .. code-block:: java - MongoCredential credential = MongoCredential.createGSSAPICredential(); + MongoCredential credential = MongoCredential.createGSSAPICredential(); credential = credential.withMechanismProperty(MongoCredential.SERVICE_NAME_KEY, "myService"); diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-subject-key.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-subject-key.rst index a5c1da73c..bb8dac028 100644 --- a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-subject-key.rst +++ b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-subject-key.rst @@ -4,6 +4,6 @@ loginContext.login(); Subject subject = loginContext.getSubject(); - MongoCredential credential = MongoCredential.createGSSAPICredential(); + MongoCredential credential = MongoCredential.createGSSAPICredential(); credential = credential.withMechanismProperty(MongoCredential.JAVA_SUBJECT_KEY, subject); diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-ticket-cache.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-ticket-cache.rst index b446e3987..7070930ed 100644 --- a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-ticket-cache.rst +++ b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi-ticket-cache.rst @@ -3,7 +3,7 @@ /* all MongoClient instances sharing this instance of KerberosSubjectProvider will share a Kerberos ticket cache */ String myLoginContext = "myContext"; - MongoCredential credential = MongoCredential.createGSSAPICredential(); + MongoCredential credential = MongoCredential.createGSSAPICredential(); /* login context defaults to "com.sun.security.jgss.krb5.initiate" if unspecified in KerberosSubjectProvider */ credential = credential.withMechanismProperty(MongoCredential.JAVA_SUBJECT_PROVIDER_KEY, diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi.rst b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi.rst index 5f76050a4..0cb0795f9 100644 --- a/source/includes/fundamentals/code-snippets/auth-credentials-gssapi.rst +++ b/source/includes/fundamentals/code-snippets/auth-credentials-gssapi.rst @@ -1,6 +1,6 @@ .. code-block:: java - MongoCredential credential = MongoCredential.createGSSAPICredential(); + MongoCredential credential = MongoCredential.createGSSAPICredential(); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() diff --git a/source/includes/fundamentals/code-snippets/auth-credentials-ldap.rst b/source/includes/fundamentals/code-snippets/auth-credentials-ldap.rst index d539843dc..a2b19de44 100644 --- a/source/includes/fundamentals/code-snippets/auth-credentials-ldap.rst +++ b/source/includes/fundamentals/code-snippets/auth-credentials-ldap.rst @@ -1,6 +1,6 @@ .. code-block:: java - MongoCredential credential = MongoCredential.createPlainCredential(, "$external", ); + MongoCredential credential = MongoCredential.createPlainCredential(, "$external", ); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() diff --git a/source/security/auth/kerberos.txt b/source/security/auth/kerberos.txt index f6129fc29..a4960e7c3 100644 --- a/source/security/auth/kerberos.txt +++ b/source/security/auth/kerberos.txt @@ -29,7 +29,7 @@ Code Placeholders The code examples on this page use the following placeholders: -- ````: Your :wikipedia:`URL-encoded ` principal name. For +- ````: Your :wikipedia:`URL-encoded ` principal name. For example: ``"username%40REALM.ME"`` - ````: The network address of your MongoDB deployment. - ````: The port number of your MongoDB deployment. If you omit this parameter, @@ -64,7 +64,7 @@ mechanism: .. code-block:: java - MongoClient mongoClient = MongoClients.create("@:/?authSource=$external&authMechanism=GSSAPI"); + MongoClient mongoClient = MongoClients.create("@:/?authSource=$external&authMechanism=GSSAPI"); .. tab:: :tabid: MongoCredential @@ -125,7 +125,7 @@ You might need to specify one or more of the following .. code-block:: java - MongoClient mongoClient = MongoClients.create("@:/?authSource=$external&authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:myService"); + MongoClient mongoClient = MongoClients.create("@:/?authSource=$external&authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:myService"); .. tab:: :tabid: MongoCredential diff --git a/source/security/auth/ldap.txt b/source/security/auth/ldap.txt index 98400289b..2fce4850e 100644 --- a/source/security/auth/ldap.txt +++ b/source/security/auth/ldap.txt @@ -34,8 +34,8 @@ Code Placeholders The code examples on this page use the following placeholders: -- ````: Your LDAP username. -- ````: Your LDAP password. +- ````: Your LDAP username. +- ````: Your LDAP password. - ````: The network address of your MongoDB deployment. - ````: 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 @@ -70,7 +70,7 @@ mechanism: .. code-block:: java - MongoClient mongoClient = MongoClients.create(":@:/?authSource=$external&authMechanism=PLAIN"); + MongoClient mongoClient = MongoClients.create(":@:/?authSource=$external&authMechanism=PLAIN"); .. tab:: :tabid: MongoCredential