Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update authentication.rst #197

Merged
merged 11 commits into from
Sep 21, 2023
18 changes: 17 additions & 1 deletion docs/authentication/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved

1) Register new Enterprise applications -> Create your own Application -> Integrate any other application you don't find in the gallery (Non-gallery)
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved
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.
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved
4) `Reply URL (Assertion Consumer Service URL)` - Use `https://your-mautic.com/s/saml/login_check`
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved
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
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved
8) Use the following for the custom attributes fields:

E-Mail: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved
First Name: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved
Last Name: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved
Username (optional): `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`
Amiyah14 marked this conversation as resolved.
Show resolved Hide resolved

Logging in
==========

Expand All @@ -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
:alt: Screenshot of the authentication settings section