Skip to content

Commit 40c5ed7

Browse files
authored
DOCS-16489 supportsHumanFlows (#5292)
* DOCS-16489 Adds supportsHumanFlows * Adjusts text * Adjusts text * Adds version note * Fixes per Ali * Fixes per Varun * Fixes per Varun * Fixes build issue * fixes per Jason * fixes per Jason
1 parent 1a36669 commit 40c5ed7

File tree

1 file changed

+55
-17
lines changed

1 file changed

+55
-17
lines changed

source/includes/fact-oidc-providers.rst

Lines changed: 55 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@
66

77
- Necessity
88

9+
- Type
10+
911
- Description
1012

11-
- Type
1213

1314
* - ``issuer``
1415

1516
- Required
1617

18+
- string
19+
1720
- The issuer URI of the IDP that the server should accept tokens from. This
1821
must match the ``iss`` field in any JWT used for authentication.
1922

@@ -26,12 +29,13 @@
2629
and validates the access token, authentication succeeds. If
2730
the issuer URI remains unreachable, authentication fails.
2831

29-
- string
3032

3133
* - ``authNamePrefix``
3234

3335
- Required
3436

37+
- string
38+
3539
- Unique prefix applied to each generated ``UserName`` and ``RoleName`` used
3640
in authorization. ``authNamePrefix`` can only contain the
3741
following characters:
@@ -40,60 +44,74 @@
4044
- hyphens (``-``)
4145
- underscores (``_``)
4246

43-
- string
44-
45-
4647

4748
* - ``matchPattern``
4849

4950
- Conditional
5051

51-
- Required when more than one IDP is defined.
52+
- string
5253

53-
Regex pattern used to determine which IDP should be used. ``matchPattern``
54+
- Regex pattern used to determine which IDP should be used. ``matchPattern``
5455
matches against usernames. Array order determines the priority and the
5556
first IDP is always selected.
5657

58+
``matchPattern`` is required in some configurations, depending on
59+
how the user sets ``supportsHumanFlows``:
60+
61+
- When only one IdP has ``supportsHumanFlows`` set to ``true``
62+
(the default), ``matchPatterns`` is optional.
63+
64+
- When multiple IdP's have ``supportsHumanFlows`` set to ``true``
65+
(the default), each of these requires ``matchPatterns``.
66+
67+
- ``matchPatterns`` is optional for any IdP where ``supportsHumanFlows``
68+
is set to ``false``.
69+
5770
This is not a security mechanism. ``matchPattern`` serves only as an advisory
5871
to clients. MongoDB accepts tokens issued by the IDP whose principal
5972
names do not match this pattern.
6073

61-
- string
6274

6375
* - ``clientId``
6476

65-
- Required
77+
- Conditional
6678

79+
- string
80+
6781
- ID provided by the IDP to identify the client that receives the access tokens.
82+
83+
Required when ``supportsHumanFlows`` is set to ``true`` (the default).
6884

69-
- string
7085

7186
* - ``audience``
7287

7388
- Required
7489

90+
- string
91+
7592
- Specifies the application or service that the access token is intended for.
7693

77-
- string
7894

7995
* - ``requestScopes``
8096

8197
- Optional
8298

99+
- array[ string ]
100+
83101
- Permissions and access levels that MongoDB requests from the IDP.
84102

85-
- array[ string ]
86-
103+
87104
* - ``principalName``
88105

89106
- Optional
90107

108+
- string
109+
91110
- The claim to be extracted from the access token containing MongoDB user
92111
identifiers.
93112

94113
The default value is ``sub`` (stands for ``subject``).
95114

96-
- string
97115

98116
* - ``useAuthorizationClaim``
99117

@@ -139,26 +157,46 @@
139157

140158
- Conditional
141159

160+
- string
161+
142162
- Required, unless ``useAuthorizationClaim`` is set to ``false``.
143163

144164
Claim extracted from access token that contains MongoDB role names.
145165

146-
- string
147166

148167
* - ``logClaims``
149168

150169
- Optional
151170

171+
- array[ string ]
172+
152173
- List of access token claims to include in log and audit messages upon
153174
authentication completion.
154175

155-
- array[ string ]
156176

157177
* - ``JWKSPollSecs``
158178

159179
- Optional
160180

181+
- integer
182+
161183
- Frequency, in seconds, to request an updated JSON Web Key Set (JWKS) from the IDP.
162184
A setting of 0 disables polling.
163185

164-
- integer
186+
187+
* - ``supportsHumanFlows``
188+
189+
- Optional
190+
191+
- bool
192+
193+
- Whether the OIDC provider supports human or machine workflows. This
194+
affects the ``clientId`` and ``matchPattern`` fields.
195+
196+
You may find it useful to set this field to ``false`` with machine workload
197+
IdP's to allow them to omit the ``clientId`` when it's unneeded.
198+
199+
Default: ``true``.
200+
201+
.. versionadded:: 7.2
202+

0 commit comments

Comments
 (0)