Difference between revisions of "SSO-SAML Custom Feature"

From SimplyBook.me
Line 1: Line 1:
 +
{{#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 on our side and connect the corresponding groups in MS Azure or add and manage the users in MS Azure only 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:#d4f8e5; padding:5px; border-radius:5px;">COMING SOON</span>
+
<br><br>
 +
;How to use:
 +
<br>
 +
:1. Create account at [https://portal.azure.com/#home Microsoft Azure] if you do not have one yet.
 +
<br>
 +
:2. Enable SSO: SAML Custom feature on your Custom features page .
 +
[[File:Sso enable path.png|border|center]]
 +
<br><br>
 +
:3. Navigate to Manage to edit the connection settings.
 +
[[File:Sso settings path.png|border|center]]
 +
<br><br>
 +
:4. Click on “Microsoft Azure Configuration” on the left and log in to your MS Azure account there to start connection setup.
 +
:'''Please note!''' You need to have administrator access in MS Azure as well to be able to connect applications.
 +
[[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 Active Directory.
 +
[[File:Ms azure select active directory.png|border|center]]
 +
<br><br>
 +
:7. Select Enterprise applications in the left-side menu and add new application.<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 non-gallery type. Add its name and save.
 +
<br><br>
 +
:9. On the next page click on “Set up single sign on” and select SAML.
 +
[[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 Pen icon in Basic SAML Configuration block to edit.
 +
[[File:Ms azure saml basic edit path.png|border|center]]
 +
<br><br>
 +
:11. Copy the urls from SimplyBook.me SSO: SAML feature to the corresponding boxes on MS Azure side. Save.
 +
[[File:Sbm saml basic settings page.png|border|center]]
 +
<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 in SSO: SAML Custom Feature.
 +
[[File:Sbm saml download cetrificate.png|border|center]]
 +
<br><br>
 +
[[File:Sbm saml certificate copy.png|border|center]]
 +
<br><br>
 +
:13. Scroll MS Azure side page to “Set up For tutorial” block and find Login URL, Azure AD Identifier and Logout URL 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 User attributes and claims block on MS Azure side and click on Pen icon to edit it.
 +
[[File:Ms azure user attributes and claims.png|border|center]]
 +
<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.
 +
[[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 Groups option using "Add group claim" and Email and Name with “Add new claim" 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 SimplyBook.me side.
 +
[[File:Sso saml claims titles copy.png|border|center]]
 +
<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.
 +
[[File:Ms azure add users path.png|border|center]]
 +
<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.
 +
: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 memberships.
 +
[[File:Ms azure add groups memberships.png|border|center]]
 +
<br><br>
 +
:22. Copy each group Object ID to the corresponding box in User Group matching 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 [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.
 +
[[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>
 +
:'''Please note!'''<br>
 +
*For such users it is not possible to reset SimplyBook.me passwords, edit access level, username, access personal data report.<br>
 +
: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.<br>
 +
*If you need to restrict access for such users you can remove or block them on MS Azure side.<br>
 +
*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.
 
<br><br>
 
<br><br>
 
<br><br>
 
<br><br>

Revision as of 13:49, 4 June 2020

Saml icon.png


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 on our side and connect the corresponding groups in MS Azure or add and manage the users in MS Azure only and the corresponding user types will be added in your SimplyBook.me system on the first login.





How to use


1. Create account at Microsoft Azure if you do not have one yet.


2. Enable SSO: SAML Custom feature on your Custom features page .
Sso enable path.png



3. Navigate to Manage to edit the connection settings.
Sso settings path.png



4. Click on “Microsoft Azure Configuration” on the left and log in to your MS Azure account there to start connection setup.
Please note! You need to have administrator access in MS Azure as well to be able to connect applications.
Sso start connection setup.png



5. After successful login you will see the first block with basic options on SimplyBook.me side.
Sso basic settings block.png



6. In MS Azure please navigate to Active Directory.
Ms azure select active directory.png



7. Select Enterprise applications in the left-side menu and add new application.
(you may need paid MS Azure or Premium trial subscription there to add applications)
Ms azure select enterprise applications.png



Ms azure new enterprise applications.png



8. Choose non-gallery type. Add its name and save.



9. On the next page click on “Set up single sign on” and select SAML.
Ms azure select single sign on.png



Ms azure select single sign on saml.png



10. Use Pen icon in Basic SAML Configuration block to edit.
Ms azure saml basic edit path.png



11. Copy the urls from SimplyBook.me SSO: SAML feature to the corresponding boxes on MS Azure side. Save.
Sbm saml basic settings page.png



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 in SSO: SAML Custom Feature.
Sbm saml download cetrificate.png



Sbm saml certificate copy.png



13. Scroll MS Azure side page to “Set up For tutorial” block and find Login URL, Azure AD Identifier and Logout URL options, Copy each of them and paste to the corresponding boxes on SimplyBook.me side.
Sbm saml to tutorial block.png



14. Go to User attributes and claims block on MS Azure side and click on Pen icon to edit it.
Ms azure user attributes and claims.png



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.
Ms azure user attributes and claims identifier.png



Ms azure user attributes and claims identifier mail.png



16. For additional claims please add Groups option using "Add group claim" and Email and Name with “Add new claim" buttons correspondingly.
You can also add phone and last name if you need. See claims setup example below.
Ms azure user attributes and claims add claim.png



17. Copy the claims titles to the corresponding boxes on SimplyBook.me side.
Sso saml claims titles copy.png



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.
Ms azure add users path.png



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.
You can create only one group if all your users have admin access, for example.
Ms azure add groups path.png



20. Add users to the corresponding groups.
Ms azure add groups users.png



21. Make sure each group contains the corresponding memberships.
Ms azure add groups memberships.png



22. Copy each group Object ID to the corresponding box in User Group matching settings on SimplyBook.me side.
(If you have only one group for admins insert same object ID everywhere in that block). Save settings.
Copy object ids from azure to sbm.png



23. Once the users are given the access to Applications dashboard they can log in to SimplyBook.me with their access level by a click on the SimplyBook.me application icon.
Application panel to login with saml.png



The corresponding user types will be added automatically to your SimplyBook.me account with the data passed according to your settings.





Please note!
  • For such users it is not possible to reset SimplyBook.me passwords, edit access level, username, access personal data report.
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.
  • If you need to restrict access for such users you can remove or block them on MS Azure side.
  • 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.





Retrieved from "https://help.simplybook.me/index.php?title=SSO-SAML_Custom_Feature&oldid=6116"