View source for SSO-SAML Custom Feature

{{#seo:
|title=SSO-SAML Custom Feature - SimplyBook.me
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, additional functionality, sso, saml, single sign-on, system login, system access, access to the account
}}

[[File:Saml icon.png| left]] <br>This custom feature allows to setup Single Sign-On process for you as the system admin and your account users thus enabling login to SimplyBook.me system from MS Azure applications panel. You can create users in MS Azure within the desired access level groups and the corresponding user types will be added in your SimplyBook.me system on the first login.
<br><br>
<br><br>
<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">'''Please note!'''</span><br>
<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">Currently SSO is available with <span style="background-color:#cdeffc; padding:5px; border-radius:5px;">[https://portal.azure.com/#home Microsoft Azure(Microsoft Entra ID)]</span> only.</span>


;How to use:
<br>
:1. Create account at <span style="background-color:#cdeffc; padding:5px; border-radius:5px;">[https://portal.azure.com/#home Microsoft Azure]</span> if you do not have one yet.
<br>
:2. Enable <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">SSO: SAML</span> Custom feature on your <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Custom features</span> page .
[[File:Sso enable path.png|border|center]]
<br><br>
:3. Navigate to <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Manage</span> to edit the connection settings.
[[File:Sso settings path.png|border|center]]
<br><br>
:4. Click on <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Microsoft Azure Configuration</span> on the left and log in to your <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">MS Azure account</span> there to start connection setup.
:<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">'''Please note!''' You need to have administrator access in MS Azure as well to be able to connect applications.</span>
[[File:Sso start connection setup.png|border|center]]
<br><br>
:5. After successful login you will see the first block with basic options on SimplyBook.me side.
[[File:Sso basic settings block.png|border|center]]
<br><br>
:6. In MS Azure please navigate to <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Active Directory.</span>
[[File:Ms azure select active directory.png|border|center]]
<br><br>
:7. Select <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Enterprise applications</span> in the left-side menu and <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">add new application.</span><br>
:(you may need paid MS Azure or Premium trial subscription there to add applications)
[[File:Ms azure select enterprise applications.png|border|center]]
<br><br>
[[File:Ms azure new enterprise applications.png|border|center]]
<br><br>
:8. Choose <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">non-gallery</span> type. Add its name and save.
<br><br>
:9. On the next page click on <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Set up single sign on</span> and select <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">SAML.</span>
[[File:Ms azure select single sign on.png|border|center]]
<br><br>
[[File:Ms azure select single sign on saml.png|border|center]]
<br><br>
:10. Use <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Pen</span> icon in <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Basic SAML Configuration</span> block to edit.
[[File:Ms azure saml basic edit path.png|border|center]]
<br><br>
:11. Copy the urls from <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">SimplyBook.me SSO: SAML feature</span> to the corresponding boxes on <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">MS Azure side.</span> Save.
[[File:Sbm saml basic settings page.png|border|center]]
<br><br>
:12. On <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">MS Azure side</span> scroll to <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">SAML Signing Certificate</span> part and download <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Certificate(Base64).</span> Open it with notepad or similar text editor, copy the certificate code and paste it to the corresponding box into <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">SSO: SAML Custom Feature.</span>
[[File:Sbm saml download cetrificate.png|border|center]]
<br><br>
[[File:Sbm saml certificate copy.png|border|center]]
<br><br>
:13. Scroll <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">MS Azure side</span> page to <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Set up For tutorial</span> block and find <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Login URL,</span> <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Azure AD Identifier</span> and <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Logout URL</span> options, Copy each of them and paste to the corresponding boxes on SimplyBook.me side.
[[File:Sbm saml to tutorial block.png|border|center]]
<br><br>
:14. Go to <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">User attributes and claims</span> block on MS Azure side and click on <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Pen</span> icon to edit it.
[[File:Ms azure user attributes and claims.png|border|center]]
<br><br>
:15. For <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Unique User Identifier</span>(click on it to edit) please set <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">user.mail</span> variable as <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Source Attribute.</span> It is the parameter that will allow us to differentiate between different user logins.
[[File:Ms azure user attributes and claims identifier.png|border|center]]
<br><br>
[[File:Ms azure user attributes and claims identifier mail.png|border|center]]
<br><br>
:16. For additional claims please add <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Groups</span> option using <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Add group claim</span> and <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Email</span> and <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Name</span> with <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Add new claim</span> buttons correspondingly.<br>
:You can also add phone and last name if you need. See claims setup example below.
[[File:Ms azure user attributes and claims add claim.png|border|center]]
<br><br>
:17. Copy the claims titles to the corresponding boxes on <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">SimplyBook.me side.</span>
[[File:Sso saml claims titles copy.png|border|center]]
<br><br>
:18. Navigate to <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Azure Active Directory homepage</span> and go to Users section, <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">create all users</span> that you would like to access the system if they are not created yet.
[[File:Ms azure add users path.png|border|center]]
<br><br>
:19. In <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Groups</span> create groups that will correspond to SimplyBook.me user types. For example, Admins for admin level users, Senior Employees for Senior Employee access, etc. 
:You can create only one group if all your users have admin access, for example.
[[File:Ms azure add groups path.png|border|center]]
<br><br>
:20. Add users to the corresponding groups.
[[File:Ms azure add groups users.png|border|center]]
<br><br>
:21. Make sure each group contains the corresponding <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">memberships.</span>
[[File:Ms azure add groups memberships.png|border|center]]
<br><br>
:22. Copy each group <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">Object ID</span> to the corresponding box in <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">User Group matching</span> settings on SimplyBook.me side. 
:(If you have only one group for admins insert same object ID everywhere in that block). Save settings.
[[File:Copy object ids from azure to sbm.png|border|center]]
<br><br>
:23. Once the users are given the access to <span style="background-color:#cdeffc; padding:5px; border-radius:5px;">[https://account.activedirectory.windowsazure.com/r#/applications Applications dashboard]</span> they can log in to SimplyBook.me with their access level by a click on the <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">SimplyBook.me application icon.</span>
[[File:Application panel to login with saml.png|border|center]]
<br><br>
:The corresponding user types will be added automatically to your SimplyBook.me account with the data passed according to your settings.
<br><br><br><br>
:<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">'''Please note!'''</span><br>
*<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">It is not possible to connect existing SimplyBook.me side users to MS Azure users.</span>
*<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">For such users it is not possible to reset SimplyBook.me passwords, edit access level, username, access personal data report.</span><br>
:<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">They need to contact MS Azure administrator if they loose access to applications page or contact SimplyBook.me default admin to request personal data report.</span><br>
*<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">If you need to restrict access for such users you can remove or block them on MS Azure side.</span><br>
*<span style="background-color:#ffe9e9; padding:5px; border-radius:5px;">If you change the group the user is included to on MS Azure side or remove the user there the access level will be updated on SimplyBook.me side within several minutes or the user will be logged out.</span>
<br><br>
<br><br>