Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<languages/>
<div lang="en" dir="ltr" class="mw-content-ltr">
{{#seo:
|title=SSO-SAML Custom Feature - SimplyBook.me
|description=Integrate SSO-SAML for secure, single-sign-on authentication. Simplify access for your team. Activate this feature now!
|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
}}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
[[File:Saml icon.png| left]] 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 or Okta applications panel. You can create users in MS Azure/Okta within the desired access level groups and the corresponding user types will be added in your SimplyBook.me system on the first login.
 
 
'''Please note!''' 
Currently SSO is available with [https://portal.azure.com/#home Microsoft Azure(Microsoft Entra ID)] & [https://www.okta.com Okta SSO] only.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
__FORCETOC__
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==How to set & use Microsoft Azure==
 
:1. Create account at [https://portal.azure.com/#home Microsoft Azure] if you do not have one yet.
 
:2. Enable SSO: SAML Custom feature on your Custom features page .
[[File:Sso enable path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/b/ba/Sso_enable_path_redesigned.png]]
 
:3. Navigate to Manage to edit the connection settings.
[[File:Sso settings path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/9/9a/Sso_settings_path_redesigned.png]]
 
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
: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 azure login path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/e/e6/Sso_azure_login_path_redesigned.png]]
 
:5. After successful login you will see the first block with basic options on SimplyBook.me side.
[[File:Sso connected first block redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/c/cf/Sso_connected_first_block_redesigned.png]]
 
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
:6. In MS Azure please navigate to Active Directory(Entra ID).
[[File:Manage ms entra id new path.png|1200px|border|center|link=]]
 
:7. Select Enterprise applications in the left-side menu and add new application. 
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
:(you may need paid MS Azure or Premium trial subscription there to add applications)
[[File:Enterprise applications ms new.png|1200px|border|center|link=https://help.simplybook.me/images/8/8d/Enterprise_applications_ms_new.png]]
 
[[File:Azure add new application path new.png|1200px|border|center|link=https://help.simplybook.me/images/9/99/Azure_add_new_application_path_new.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.
[[File:Azure single sign on type.png|1200px|border|center|link=https://help.simplybook.me/images/0/01/Azure_single_sign_on_type.png]]
 
[[File:Ms azure select single sign on saml.png|border|center]]
 
:10. Use Pen icon in Basic SAML Configuration block to edit.
[[File:Ms azure saml basic edit path.png|border|center]]
 
:11. Copy the urls from SimplyBook.me SSO: SAML feature to the corresponding boxes on MS Azure side. Save.
[[File:Entity is and reply url azure copy new.png|1200px|border|center|link=https://help.simplybook.me/images/8/84/Entity_is_and_reply_url_azure_copy_new.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 into SSO: SAML Custom Feature.
[[File:Sbm saml download cetrificate.png|border|center]]
 
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
[[File:Base64 certificate paste new.png|1200px|border|center|link=https://help.simplybook.me/images/e/e6/Base64_certificate_paste_new.png]]
 
:13. Scroll MS Azure side page to Set up block and find Login URL, Azure AD/Microsoft Entra Identifier and Logout URL options, Copy each of them and paste to the corresponding boxes on SimplyBook.me side.
[[File:Login logout and azure id new.png|1200px|border|center|link=https://help.simplybook.me/images/4/4c/Login_logout_and_azure_id_new.png]]
 
: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]]
 
: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]]
 
[[File:Ms azure user attributes and claims identifier mail.png|border|center]]
 
: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.
[[File:Setup claims new.png|1200px|border|center|link=https://help.simplybook.me/images/8/81/Setup_claims_new.png]]
 
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
:17. Copy the claims titles to the corresponding boxes on SimplyBook.me side.
[[File:Copy claims new.png|1200px|border|center|link=https://help.simplybook.me/images/9/9b/Copy_claims_new.png]]
 
:18. Navigate to Azure Active Directory/Entra ID 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]]
 
: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]]
 
:20. Add users to the corresponding groups.
[[File:Ms azure add groups users.png|border|center]]
 
:21. 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:Add groups object ids new.png|1200px|border|center|link=https://help.simplybook.me/images/e/e9/Add_groups_object_ids_new.png]]
 
:22. 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]]
 
:The corresponding user types will be added automatically to your SimplyBook.me account with the data passed according to your settings.
 
:'''Please note!''' 
*It is not possible to connect existing SimplyBook.me side users to MS Azure users.
*For such users it is not possible to reset SimplyBook.me passwords, edit access level, username. 
: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.
 
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
==How to set & use Okta==
:1. Create account at [https://www.okta.com Okta].
 
:2. Navigate to '''Applications''' in Okta admin panel and click to create a new app there.
[[File:Okta create app integration path.png|1200px|center|link=https://help.simplybook.me/images/c/c7/Okta_create_app_integration_path.png]]
 
:3. Add the desirable name and upload a logo.
[[File:Okta app add name & logo.png|1200px|center|link=https://help.simplybook.me/images/0/0a/Okta_app_add_name_%26_logo.png]]
 
:4. Select '''SAML''' method.
[[File:Okta app saml select.png|1200px|center|link=https://help.simplybook.me/images/4/4b/Okta_app_saml_select.png]]
 
:5. On the SAML settings step please copy the '''Audience URI''' and '''Okta Single Sign-On URL''' from SimplyBook.me SSO-SAML custom feature -> Manage -> Okta SAML Single Sign-On and paste to the corresponding fields on the Okta side.
[[File:Create saml integration step 1.png|1200px|center|link=https://help.simplybook.me/images/3/37/Create_saml_integration_step_1.png]]
 
:6. Set '''Name ID''' and '''Application username''' as in the image below.
[[File:Create saml integrattion 2.png|1200px|center|link=https://help.simplybook.me/images/3/32/Create_saml_integrattion_2.png]]
 
:7. Scroll the page to '''Attribute settings''' and add the attributes for name, email, id and firstname as in the example. 
:And separately '''group''' attribute in the corresponding block. 
[[File:Saml add attribite statements.png|1200px|center|link=https://help.simplybook.me/images/8/8c/Saml_add_attribite_statements.png]]
 
:On the SimplyBook.me side please make sure the same attributes are indicated in the '''User attributes and claims''' tab.
 
:8. Proceed to the next step.
[[File:Saml proceed to the next.png|1200px|center|link=https://help.simplybook.me/images/0/03/Saml_proceed_to_the_next.png]]
 
:9. The app is now saved. Please open '''Sign on''' tab and click on ''' on '''More details''' there.
[[File:Saml sign on more details.png|1200px|center|link=https://help.simplybook.me/images/4/4c/Saml_sign_on_more_details.png]]
 
:10. Copy '''Sign on URL''', '''Sign out URL''', '''Issuer''' and '''Signing certificate''' in Okta and paste them to the corresponding fields in SimplyBook.me SSO-SAML custom feature -> Manage -> Okta SAML Single Sign-On 
[[File:Saml copy urls from okta.png|1200px|center|link=https://help.simplybook.me/images/3/38/Saml_copy_urls_from_okta.png]]
 
:11. Now in Okta interface make sure all necessary employees are added to the system in '''People''' tab.
[[File:Add people okta.png|1200px|center|link=https://help.simplybook.me/images/b/b7/Add_people_okta.png]]
 
:12. In '''Groups''' tab - create the groups matching the SimplyBook.me access levels. Assign the employees to these groups.
[[File:Create groups okta.png|1200px|center|link=https://help.simplybook.me/images/c/c0/Create_groups_okta.png]]
[[File:Assign people to groups okta.png|1200px|center|link=https://help.simplybook.me/images/0/07/Assign_people_to_groups_okta.png]]
 
:13. Assign the groups and people to the application that you've created.
[[File:Assign applications to groups.png|1200px|center|link=https://help.simplybook.me/images/7/78/Assign_applications_to_groups.png]]
 
:14. In the SimplyBook.me side please indicate the groups names in the '''User groups matching settings''' tab. Save settings.
 
:15. Everything is ready now. Your employees an now log in to your company account at SimplyBook.me with one single click on the Okta panel (the user in SimplyBook.me will be automatically create on the first login with the corresponding rights)
[[File:Login screen okta.png|1200px|center|link=https://help.simplybook.me/images/0/06/Login_screen_okta.png]]
 
 
</div>