Skip to content

Commit da191c2

Browse files
Compass OIDC-docs merge into master (#510)
* DOCSP-29126 Add OIDC to settings and authentication connection. (#508) * DOCSP-29126 add oidc * DOCSP-29126 typo fixes * DOCSP-29126 nit change * oidc-docs update * oidc-docs update * oidc-docs testing link * oidc-docs fix 404 * oidc-docs testing links
1 parent e15191d commit da191c2

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

source/connect/advanced-connection-options/authentication-connection.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Procedure
3434
Select your authentication method from the following options:
3535

3636
- :ref:`Username / Password <username-password>`
37+
38+
- :ref:`OIDC <oidc>`
3739

3840
- :ref:`X.509 <x509>`
3941

@@ -82,6 +84,44 @@ Procedure
8284

8385
- :manual:`SCRAM-SHA-256 </core/security-scram/>`
8486

87+
.. _oidc:
88+
89+
OIDC
90+
~~~~
91+
92+
Select :guilabel:`OIDC` if the deployment uses :manual:`OpenID Connect </core/security-oidc/>`
93+
as its authentication mechanism.
94+
95+
Provide the following information:
96+
97+
.. list-table::
98+
:header-rows: 1
99+
:widths: 50 50
100+
101+
* - Field
102+
- Description
103+
104+
* - Username
105+
- Optional. OpenID Connect username.
106+
107+
* - Auth Code Flow Redirect URI
108+
- Optional. Specify a URI where the identity provider redirects you after authentication.
109+
The URI must match the configuration of the Identity Provider.
110+
The default is ``http://localhost:27097/redirect``.
111+
112+
* - Consider Target Endpoint Trusted
113+
- Optional. Allows connecting to a target endpoint that is not in the
114+
list of endpoints that are considered trusted by default. Only use
115+
this option when connecting to servers that you trust.
116+
117+
* - Enable Device Authentication Flow
118+
- Optional. When the :ref:`Show Device Auth Flow Checkbox <compass-settings-reference>`
119+
setting is enabled, |compass-short| can provide you with a URL and code
120+
to finish authentication.
121+
122+
This is a less secure authentication flow that can be used as a
123+
fallback when browser-based authentication is unavailable.
124+
85125
.. _x509:
86126

87127
X.509

source/settings/settings-reference.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,22 @@ You can configure the following settings on the |compass| interface:
131131
- Allow our Product team to occasionally reach out for feedback about
132132
|compass-short|.
133133

134+
* - Browser command to use for OIDC Authentication
135+
- OIDC
136+
- Specify the browser that |compass-short| redirects you to when authenticating
137+
with the identity provider.
138+
139+
* - Show Device Auth Flow Checkbox
140+
- OIDC
141+
- Show a check box on the connection form to enable the device authentication flow.
142+
This provides the option to enable a less secure authentication flow as a
143+
fallback when browser-based authentication is unavailable.
144+
145+
* - Stay logged in with OIDC
146+
- OIDC
147+
- Remain logged in when using the :manual:`MONGODB-OIDC </core/security-oidc/>`
148+
authentication mechanism.
149+
134150
Learn More
135151
----------
136152

0 commit comments

Comments
 (0)