From d8782ef24acb63453612be2ca0823a66bb67d86c Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Mon, 28 Aug 2023 13:42:12 +0200 Subject: [PATCH 01/10] Update authentication.rst Added correct configuration for Azure SAML SSO --- docs/authentication/authentication.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index 3bf881e1..8f627348 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -48,6 +48,22 @@ The IDP may ask for the following settings: #. Custom attributes - Mautic requires three custom attributes in the IDP responses for the User Email, first name and last name. Username is also supported but is optional. Configure the attribute names used by the IDP in Mautic's Configuration > User/Authentication Settings under the 'Enter the names of the attributes the configured IDP uses for the following Mautic User fields' section. +### Example Azure SAML SSO + +1) Register new Enterprise applications -> Create your own Application -> Integrate any other application you don't find in the gallery (Non-gallery) +2) Go to Single Sign-On +3) `Identifier (Entity ID)` - this will be site URL and is displayed at the top of User/Authentication Settings. Copy this exactly as is to the IDP. +4) `Reply URL (Assertion Consumer Service URL)` - Use `https://your-mautic.com/s/saml/login_check` +5) Download Federation Metadata XML from 3. SAML Certificates +6) Upload the downloaded Federation Metadata XML to Mautic +7) X.509-Certificate is not required +8) Use the following for the custom attributes fields: + +E-Mail: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` +First Name: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname` +Last Name: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname` +Username (optional): `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` + Logging in ========== @@ -62,4 +78,4 @@ To turn off SAML, click the Remove link to the right of the Identity provider me .. image:: images/authentication-settings.png :width: 800 - :alt: Screenshot of the authentication settings section \ No newline at end of file + :alt: Screenshot of the authentication settings section From e99b5574b00ef4393539669637b4aee3a47845e4 Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:33:51 +0200 Subject: [PATCH 02/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index 8f627348..6dadf17b 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -48,7 +48,8 @@ The IDP may ask for the following settings: #. Custom attributes - Mautic requires three custom attributes in the IDP responses for the User Email, first name and last name. Username is also supported but is optional. Configure the attribute names used by the IDP in Mautic's Configuration > User/Authentication Settings under the 'Enter the names of the attributes the configured IDP uses for the following Mautic User fields' section. -### Example Azure SAML SSO +Example: Azure SAML SSO +======================= 1) Register new Enterprise applications -> Create your own Application -> Integrate any other application you don't find in the gallery (Non-gallery) 2) Go to Single Sign-On From ab66ca8acbd23ba3abaf59237090ea05f1ee6e9e Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:34:07 +0200 Subject: [PATCH 03/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index 6dadf17b..a6ba9ff2 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -54,7 +54,7 @@ Example: Azure SAML SSO 1) Register new Enterprise applications -> Create your own Application -> Integrate any other application you don't find in the gallery (Non-gallery) 2) Go to Single Sign-On 3) `Identifier (Entity ID)` - this will be site URL and is displayed at the top of User/Authentication Settings. Copy this exactly as is to the IDP. -4) `Reply URL (Assertion Consumer Service URL)` - Use `https://your-mautic.com/s/saml/login_check` +4) ``Reply URL (Assertion Consumer Service URL)`` - Use ``https://example.com/s/saml/login_check`` 5) Download Federation Metadata XML from 3. SAML Certificates 6) Upload the downloaded Federation Metadata XML to Mautic 7) X.509-Certificate is not required From ee221f7c8c2564c20a8216089ea6f89370e3252a Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:34:17 +0200 Subject: [PATCH 04/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index a6ba9ff2..cb944bf6 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -51,7 +51,7 @@ The IDP may ask for the following settings: Example: Azure SAML SSO ======================= -1) Register new Enterprise applications -> Create your own Application -> Integrate any other application you don't find in the gallery (Non-gallery) +1) Register new Enterprise applications by navigating to ``Create your own Application`` and then ``Integrate any other application you don't find in the gallery (Non-gallery)`` 2) Go to Single Sign-On 3) `Identifier (Entity ID)` - this will be site URL and is displayed at the top of User/Authentication Settings. Copy this exactly as is to the IDP. 4) ``Reply URL (Assertion Consumer Service URL)`` - Use ``https://example.com/s/saml/login_check`` From 1b98dc5b53d71c51b92839bf2a7a8db645de869c Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:34:23 +0200 Subject: [PATCH 05/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index cb944bf6..86bf9adc 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -53,7 +53,7 @@ Example: Azure SAML SSO 1) Register new Enterprise applications by navigating to ``Create your own Application`` and then ``Integrate any other application you don't find in the gallery (Non-gallery)`` 2) Go to Single Sign-On -3) `Identifier (Entity ID)` - this will be site URL and is displayed at the top of User/Authentication Settings. Copy this exactly as is to the IDP. +3) ``Identifier (Entity ID)`` - this is the site URL located at the top of User/Authentication Settings. Copy this exactly as is to the IDP. 4) ``Reply URL (Assertion Consumer Service URL)`` - Use ``https://example.com/s/saml/login_check`` 5) Download Federation Metadata XML from 3. SAML Certificates 6) Upload the downloaded Federation Metadata XML to Mautic From e7096bcde1eee0ba4036a3937a4df07a91ed8b0f Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:34:30 +0200 Subject: [PATCH 06/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index 86bf9adc..b20485d2 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -57,7 +57,7 @@ Example: Azure SAML SSO 4) ``Reply URL (Assertion Consumer Service URL)`` - Use ``https://example.com/s/saml/login_check`` 5) Download Federation Metadata XML from 3. SAML Certificates 6) Upload the downloaded Federation Metadata XML to Mautic -7) X.509-Certificate is not required +7) X.509-Certificate isn't required 8) Use the following for the custom attributes fields: E-Mail: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` From 7e35aceea490b342886c1840f4dabd98c4f755ee Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:34:36 +0200 Subject: [PATCH 07/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index b20485d2..22c25fb7 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -61,7 +61,7 @@ Example: Azure SAML SSO 8) Use the following for the custom attributes fields: E-Mail: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` -First Name: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname` +First Name: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`` Last Name: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname` Username (optional): `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` From fce16c4ece8f5635bb60762e262d51f75e989ccf Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:34:42 +0200 Subject: [PATCH 08/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index 22c25fb7..ae19c18d 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -62,7 +62,7 @@ Example: Azure SAML SSO E-Mail: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` First Name: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`` -Last Name: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname` +Last Name: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`` Username (optional): `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` Logging in From dd315f3e0cd74440d40e21ddc6f1334863ed137f Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:34:58 +0200 Subject: [PATCH 09/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index ae19c18d..0da1b846 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -63,7 +63,7 @@ Example: Azure SAML SSO E-Mail: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` First Name: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`` Last Name: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`` -Username (optional): `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` +Username (optional): ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`` Logging in ========== From 55f81b7d965b84219182dfaf134636b67c271433 Mon Sep 17 00:00:00 2001 From: Emily <45315891+Amiyah14@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:37:16 +0200 Subject: [PATCH 10/10] Update docs/authentication/authentication.rst Co-authored-by: Ruth Cheesley --- docs/authentication/authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authentication/authentication.rst b/docs/authentication/authentication.rst index 0da1b846..fd48f39d 100644 --- a/docs/authentication/authentication.rst +++ b/docs/authentication/authentication.rst @@ -60,7 +60,7 @@ Example: Azure SAML SSO 7) X.509-Certificate isn't required 8) Use the following for the custom attributes fields: -E-Mail: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` +E-Mail: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`` First Name: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`` Last Name: ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`` Username (optional): ``http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress``