|
6 | 6 |
|
7 | 7 | - Necessity
|
8 | 8 |
|
| 9 | + - Type |
| 10 | + |
9 | 11 | - Description
|
10 | 12 |
|
11 |
| - - Type |
12 | 13 |
|
13 | 14 | * - ``issuer``
|
14 | 15 |
|
15 | 16 | - Required
|
16 | 17 |
|
| 18 | + - string |
| 19 | + |
17 | 20 | - The issuer URI of the IDP that the server should accept tokens from. This
|
18 | 21 | must match the ``iss`` field in any JWT used for authentication.
|
19 | 22 |
|
|
26 | 29 | and validates the access token, authentication succeeds. If
|
27 | 30 | the issuer URI remains unreachable, authentication fails.
|
28 | 31 |
|
29 |
| - - string |
30 | 32 |
|
31 | 33 | * - ``authNamePrefix``
|
32 | 34 |
|
33 | 35 | - Required
|
34 | 36 |
|
| 37 | + - string |
| 38 | + |
35 | 39 | - Unique prefix applied to each generated ``UserName`` and ``RoleName`` used
|
36 | 40 | in authorization. ``authNamePrefix`` can only contain the
|
37 | 41 | following characters:
|
|
40 | 44 | - hyphens (``-``)
|
41 | 45 | - underscores (``_``)
|
42 | 46 |
|
43 |
| - - string |
44 |
| - |
45 |
| - |
46 | 47 |
|
47 | 48 | * - ``matchPattern``
|
48 | 49 |
|
49 | 50 | - Conditional
|
50 | 51 |
|
51 |
| - - Required when more than one IDP is defined. |
| 52 | + - string |
52 | 53 |
|
53 |
| - Regex pattern used to determine which IDP should be used. ``matchPattern`` |
| 54 | + - Regex pattern used to determine which IDP should be used. ``matchPattern`` |
54 | 55 | matches against usernames. Array order determines the priority and the
|
55 | 56 | first IDP is always selected.
|
56 | 57 |
|
| 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 | + |
57 | 70 | This is not a security mechanism. ``matchPattern`` serves only as an advisory
|
58 | 71 | to clients. MongoDB accepts tokens issued by the IDP whose principal
|
59 | 72 | names do not match this pattern.
|
60 | 73 |
|
61 |
| - - string |
62 | 74 |
|
63 | 75 | * - ``clientId``
|
64 | 76 |
|
65 |
| - - Required |
| 77 | + - Conditional |
66 | 78 |
|
| 79 | + - string |
| 80 | + |
67 | 81 | - 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). |
68 | 84 |
|
69 |
| - - string |
70 | 85 |
|
71 | 86 | * - ``audience``
|
72 | 87 |
|
73 | 88 | - Required
|
74 | 89 |
|
| 90 | + - string |
| 91 | + |
75 | 92 | - Specifies the application or service that the access token is intended for.
|
76 | 93 |
|
77 |
| - - string |
78 | 94 |
|
79 | 95 | * - ``requestScopes``
|
80 | 96 |
|
81 | 97 | - Optional
|
82 | 98 |
|
| 99 | + - array[ string ] |
| 100 | + |
83 | 101 | - Permissions and access levels that MongoDB requests from the IDP.
|
84 | 102 |
|
85 |
| - - array[ string ] |
86 |
| - |
| 103 | + |
87 | 104 | * - ``principalName``
|
88 | 105 |
|
89 | 106 | - Optional
|
90 | 107 |
|
| 108 | + - string |
| 109 | + |
91 | 110 | - The claim to be extracted from the access token containing MongoDB user
|
92 | 111 | identifiers.
|
93 | 112 |
|
94 | 113 | The default value is ``sub`` (stands for ``subject``).
|
95 | 114 |
|
96 |
| - - string |
97 | 115 |
|
98 | 116 | * - ``useAuthorizationClaim``
|
99 | 117 |
|
|
139 | 157 |
|
140 | 158 | - Conditional
|
141 | 159 |
|
| 160 | + - string |
| 161 | + |
142 | 162 | - Required, unless ``useAuthorizationClaim`` is set to ``false``.
|
143 | 163 |
|
144 | 164 | Claim extracted from access token that contains MongoDB role names.
|
145 | 165 |
|
146 |
| - - string |
147 | 166 |
|
148 | 167 | * - ``logClaims``
|
149 | 168 |
|
150 | 169 | - Optional
|
151 | 170 |
|
| 171 | + - array[ string ] |
| 172 | + |
152 | 173 | - List of access token claims to include in log and audit messages upon
|
153 | 174 | authentication completion.
|
154 | 175 |
|
155 |
| - - array[ string ] |
156 | 176 |
|
157 | 177 | * - ``JWKSPollSecs``
|
158 | 178 |
|
159 | 179 | - Optional
|
160 | 180 |
|
| 181 | + - integer |
| 182 | + |
161 | 183 | - Frequency, in seconds, to request an updated JSON Web Key Set (JWKS) from the IDP.
|
162 | 184 | A setting of 0 disables polling.
|
163 | 185 |
|
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