Skip to content

Commit 15f33f3

Browse files
authored
(DOCSP-29556) Add SAML project and org roles steps to the SAML procedure (#5165) (#5167)
* (DOCSP-29556) Add SAML project and org roles steps to the SAML procedure * Edits * Copy review
1 parent 36d835d commit 15f33f3

File tree

2 files changed

+107
-5
lines changed

2 files changed

+107
-5
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. important::
22

33
You must use the fully qualified distinguished name for each
4-
group. If multiple LDAP groups correspond to the same role,
4+
group. If multiple LDAP or SAML groups correspond to the same role,
55
separate them with two semicolons (``;;``). Remove a group
66
from a role's field to revoke the group's access for that
77
role.

source/includes/steps-configure-saml-authentication.yaml

Lines changed: 106 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -232,11 +232,113 @@ content: |
232232
:authrole:`Global Read Only` role.
233233
- None
234234
235-
Click :guilabel:`Save`.
235+
---
236+
title: "Click :guilabel:`Save`."
237+
stepnum: 7
238+
ref: save-saml
239+
---
240+
title: "Log in as a global owner."
241+
stepnum: 8
242+
ref: first-user-saml
243+
content: |
244+
Log in to |mms| as a user that is part of the SAML group
245+
specified in the |mms| :guilabel:`SAML Global Role Owner` field.
246+
247+
Upon successful login, |mms| displays your projects page.
248+
---
249+
title: "Associate SAML groups with project roles."
250+
stepnum: 9
251+
ref: group-level-roles-saml
252+
action:
253+
254+
- heading: "To associate SAML groups with roles in a new project:"
255+
pre: |
256+
257+
.. note::
258+
259+
You must have any :ref:`global role <global-user-admin-role>`
260+
to create a new project.
261+
262+
a. Click :guilabel:`Admin` > :guilabel:`General` > :guilabel:`Projects`.
263+
264+
#. Click :guilabel:`Create a New Project`.
265+
266+
#. In :guilabel:`Project Name`, type a name for the new |mms| project.
267+
268+
#. Enter the SAML groups that correspond to
269+
each :ref:`project role <project-roles>`.
270+
271+
.. include:: /includes/admonitions/important/ldap-role-guidance.rst
272+
273+
#. Click :guilabel:`Add Project`.
274+
275+
- heading: "To update the association of SAML groups with roles in an existing project:"
276+
pre: |
277+
278+
a. Click :guilabel:`Admin` > :guilabel:`General` > :guilabel:`Projects`.
279+
280+
#. In the :guilabel:`Actions` column for a project, click
281+
:icon-mms:`ellipsis`, then click
282+
:guilabel:`Edit SAML Settings`.
283+
284+
#. Enter the SAML groups that correspond to each :ref:`project
285+
role <project-roles>`.
286+
287+
.. include:: /includes/admonitions/important/ldap-role-guidance.rst
288+
289+
#. Click :guilabel:`Save Changes`.
290+
---
291+
title: "Associate LDAP groups with organization roles."
292+
stepnum: 10
293+
optional: true
294+
ref: organization-level-roles-saml
295+
action:
296+
297+
- heading: "To associate SAML groups with roles for a new organization:"
298+
pre: |
299+
300+
.. note::
301+
302+
You must have any :ref:`global role <global-user-admin-role>`
303+
to create a new organization.
304+
305+
a. Click :guilabel:`Admin` > :guilabel:`General` > :guilabel:`Organizations`.
306+
307+
#. Click :guilabel:`Create a New Organization`.
308+
309+
#. In :guilabel:`Organization Name`, type a name for the new |mms| organization.
310+
311+
#. Enter the SAML groups that correspond to
312+
each :ref:`organization role <organization-roles>`.
313+
314+
.. include:: /includes/admonitions/important/ldap-role-guidance.rst
315+
316+
#. Click :guilabel:`Add Organization`.
317+
318+
- heading: "To update the association of SAML groups with roles for an existing organization:"
319+
pre: |
320+
321+
a. Click :guilabel:`Admin` > :guilabel:`General` > :guilabel:`Organizations`.
322+
323+
b. Click the :guilabel:`Edit Org` button.
324+
325+
c. Enter the SAML groups that correspond to
326+
each :ref:`organization role <organization-roles>`.
327+
328+
.. include:: /includes/admonitions/important/ldap-role-guidance.rst
329+
330+
#. Click :guilabel:`Save Changes`.
331+
---
332+
title: "Add your MongoDB deployments."
333+
stepnum: 11
334+
ref: deploy-mongodb
335+
content: |
336+
Specify the SAML authentication settings when :doc:`adding a MongoDB
337+
deployment </tutorial/add-existing-mongodb-processes>`.
236338
237339
---
238340
title: "Export your |onprem| Metadata."
239-
stepnum: 7
341+
stepnum: 12
240342
level: 4
241343
ref: export-metadata
242344
content: |
@@ -262,7 +364,7 @@ content: |
262364
263365
---
264366
title: "Import the |saml| SP Metadata into your |idp|."
265-
stepnum: 8
367+
stepnum: 13
266368
level: 4
267369
ref: import-sp-saml-values
268370
content: |
@@ -296,7 +398,7 @@ content: |
296398
297399
---
298400
title: "Test the |saml| integration between |onprem| and your |idp|."
299-
stepnum: 9
401+
stepnum: 14
300402
level: 4
301403
ref: test-saml
302404
content: |

0 commit comments

Comments
 (0)