Skip to content

Commit 6952da5

Browse files
DOCSP-35650 updated auth param requirement (#114)
updated the wording about needing a sub param for `auth`.
1 parent 617e526 commit 6952da5

File tree

2 files changed

+18
-20
lines changed
  • source/includes/api

2 files changed

+18
-20
lines changed

source/includes/api/automation-configuration/auth.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
|mms| doesn't require the ``auth`` object. This object defines
2-
:manual:`authentication-related </core/authentication>` settings.
1+
To enable authentication, configure the ``auth`` object. This object is
2+
optional and defines :manual:`authentication-related
3+
</core/authentication>` settings.
34

45
.. code-block:: json
56
:linenos:

source/includes/api/list-tables/auto-config/auth.rst

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. list-table::
2-
:widths: 20 14 11 55
2+
:widths: 20 14 12 54
33
:header-rows: 1
44
:stub-columns: 1
55

@@ -33,23 +33,23 @@
3333

3434
**auth.authoritativeSet** defaults to **false**.
3535

36-
Required if **"auth" : true**.
36+
**Required if you enable authentication.**
3737

3838
* - auth.autoUser
3939
- string
4040
- Conditional
4141
- Username that the {+aagent+} uses when connecting to an
4242
instance.
4343

44-
Required if **"auth" : true**.
44+
**Required if you enable authentication.**
4545

4646
* - auth.autoPwd
4747
- string
4848
- Conditional
4949
- Password that the {+aagent+} uses when connecting to an
5050
instance.
5151

52-
Required if **"auth" : true**.
52+
**Required if you enable authentication.**
5353

5454
* - auth.disabled
5555
- boolean
@@ -63,7 +63,7 @@
6363
- Lists the supported authentication mechanisms for the processes
6464
in the deployment.
6565

66-
Required if **"auth" : true**.
66+
**Required if you enable authentication.**
6767

6868
Specify:
6969

@@ -94,8 +94,8 @@
9494
- Conditional
9595
- Sets the authentication mechanism used by the {+aagent+}.
9696
If not specified, **disabled** defaults to **false**.
97-
98-
Required if **"auth" : true**.
97+
98+
**Required if you enable authentication.**
9999

100100
.. note::
101101

@@ -126,15 +126,13 @@
126126
* - GSSAPI
127127
- :ref:`Kerberos <security-auth-kerberos>`
128128

129-
130-
131129
* - auth.key
132130
- string
133131
- Conditional
134132
- Contents of the key file that |mms| uses to authenticate to the
135133
MongoDB processes.
136134

137-
Required if **"auth" : true** and **"auth.disabled" : false**.
135+
Required if **you enable authentication** and **"auth.disabled" : false**.
138136

139137
.. note::
140138

@@ -147,7 +145,7 @@
147145
- Path and name of the key file that |mms| uses to authenticate to
148146
the MongoDB processes.
149147

150-
Required if **"auth" : true** and **"auth.disabled" : false**.
148+
Required if **you enable authentication** and **"auth.disabled" : false**.
151149

152150
.. note::
153151

@@ -233,10 +231,9 @@
233231

234232
Required if:
235233

236-
- **"auth" : true**,
237-
- **"auth.deploymentAuthMechanisms" : "MONGODB-CR"**, and
238-
- **"auth.usersWanted[n].initPwd"** is unset.
239-
234+
- You enable authentication
235+
- **"auth.deploymentAuthMechanisms" : "MONGODB-CR"**
236+
- **"auth.usersWanted[n].initPwd"** is unset
240237

241238
* - auth.usersWanted[n].initPwd
242239
- string
@@ -245,9 +242,9 @@
245242

246243
Required if:
247244

248-
- **"auth" : true**,
249-
- **"auth.deploymentAuthMechanisms" : "MONGODB-CR"**, and
250-
- **"auth.usersWanted[n].pwd"** is unset.
245+
- You enable authentication
246+
- **"auth.deploymentAuthMechanisms" : "MONGODB-CR"**
247+
- **"auth.usersWanted[n].initPwd"** is unset
251248

252249
* - auth.usersWanted[n].userSource
253250
- string

0 commit comments

Comments
 (0)