SSO-SAML Custom Feature: Difference between revisions
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
;How to use: | ;How to use: | ||
<br> | <br> | ||
:1. Create account at [https://portal.azure.com/#home Microsoft Azure] if you do not have one yet. | :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> | <br> | ||
:2. Enable SSO: SAML Custom feature on your Custom features page . | :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]] | [[File:Sso enable path.png|border|center]] | ||
<br><br> | <br><br> | ||
:3. Navigate to Manage to edit the connection settings. | :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]] | [[File:Sso settings path.png|border|center]] | ||
<br><br> | <br><br> | ||
:4. Click on | :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> | :<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]] | [[File:Sso start connection setup.png|border|center]] | ||
| Line 25: | Line 25: | ||
[[File:Sso basic settings block.png|border|center]] | [[File:Sso basic settings block.png|border|center]] | ||
<br><br> | <br><br> | ||
:6. In MS Azure please navigate to Active Directory. | :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]] | [[File:Ms azure select active directory.png|border|center]] | ||
<br><br> | <br><br> | ||
:7. Select Enterprise applications in the left-side menu and add new application.<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) | :(you may need paid MS Azure or Premium trial subscription there to add applications) | ||
[[File:Ms azure select enterprise applications.png|border|center]] | [[File:Ms azure select enterprise applications.png|border|center]] | ||
| Line 34: | Line 34: | ||
[[File:Ms azure new enterprise applications.png|border|center]] | [[File:Ms azure new enterprise applications.png|border|center]] | ||
<br><br> | <br><br> | ||
:8. Choose non-gallery type. Add its name and save. | :8. Choose <span style="background-color:#d4f8e5; padding:5px; border-radius:5px;">non-gallery</span> type. Add its name and save. | ||
<br><br> | <br><br> | ||
:9. On the next page click on | :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]] | [[File:Ms azure select single sign on.png|border|center]] | ||
<br><br> | <br><br> | ||
[[File:Ms azure select single sign on saml.png|border|center]] | [[File:Ms azure select single sign on saml.png|border|center]] | ||
<br><br> | <br><br> | ||
:10. Use Pen icon in Basic SAML Configuration block to edit. | :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]] | [[File:Ms azure saml basic edit path.png|border|center]] | ||
<br><br> | <br><br> | ||
:11. Copy the urls from SimplyBook.me SSO: SAML feature to the corresponding boxes on MS Azure side. Save. | :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]] | [[File:Sbm saml basic settings page.png|border|center]] | ||
<br><br> | <br><br> | ||
:12. On MS Azure side scroll to SAML Signing Certificate part and download Certificate(Base64). Open it with notepad or similar text editor, copy the certificate code and paste it to the corresponding box | :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]] | [[File:Sbm saml download cetrificate.png|border|center]] | ||
<br><br> | <br><br> | ||
[[File:Sbm saml certificate copy.png|border|center]] | [[File:Sbm saml certificate copy.png|border|center]] | ||
<br><br> | <br><br> | ||
:13. Scroll MS Azure side page to | :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]] | [[File:Sbm saml to tutorial block.png|border|center]] | ||
<br><br> | <br><br> | ||
:14. Go to User attributes and claims block on MS Azure side and click on Pen icon to edit it. | :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]] | [[File:Ms azure user attributes and claims.png|border|center]] | ||
<br><br> | <br><br> | ||
:15. For Unique User Identifier(click on it to edit) please set user.mail variable as Source Attribute. It is the parameter that will allow us to differentiate between different user logins. | :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]] | [[File:Ms azure user attributes and claims identifier.png|border|center]] | ||
<br><br> | <br><br> | ||
[[File:Ms azure user attributes and claims identifier mail.png|border|center]] | [[File:Ms azure user attributes and claims identifier mail.png|border|center]] | ||
<br><br> | <br><br> | ||
:16. For additional claims please add Groups option using "Add group claim" | :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. | :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]] | [[File:Ms azure user attributes and claims add claim.png|border|center]] | ||
<br><br> | <br><br> | ||
:17. Copy the claims titles to the corresponding boxes on SimplyBook.me side. | :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]] | [[File:Sso saml claims titles copy.png|border|center]] | ||
<br><br> | <br><br> | ||
:18. Navigate to Azure Active Directory homepage and go to Users section, create all users that you would like to access the system if they are not created yet. | :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]] | [[File:Ms azure add users path.png|border|center]] | ||
<br><br> | <br><br> | ||
:19. In Groups create groups that will correspond to SimplyBook.me user types. For example, Admins for admin level users, Senior Employees for Senior Employee access, etc. | :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. | :You can create only one group if all your users have admin access, for example. | ||
[[File:Ms azure add groups path.png|border|center]] | [[File:Ms azure add groups path.png|border|center]] | ||
| Line 80: | Line 80: | ||
[[File:Ms azure add groups users.png|border|center]] | [[File:Ms azure add groups users.png|border|center]] | ||
<br><br> | <br><br> | ||
:21. Make sure each group contains the corresponding memberships. | :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]] | [[File:Ms azure add groups memberships.png|border|center]] | ||
<br><br> | <br><br> | ||
:22. Copy each group Object ID to the corresponding box in User Group matching settings on SimplyBook.me side. | :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. | :(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]] | [[File:Copy object ids from azure to sbm.png|border|center]] | ||
<br><br> | <br><br> | ||
:23. Once the users are given the access to [https://account.activedirectory.windowsazure.com/r#/applications Applications dashboard] they can log in to SimplyBook.me with their access level by a click on the SimplyBook.me application icon. | :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]] | [[File:Application panel to login with saml.png|border|center]] | ||
<br><br> | <br><br> | ||