NOTE: We currently don't support clicking on the app tile within the IdP, users must access the Cheqroom login page. We recommend that you bookmark that link for faster access. This is because we only support SP-initiated SSO flow.
You'll learn how to configure SSO on your Cheqroom account using SAML Idp:
Enable SAML integration
Log in to your Cheqroom account
Go to Settings
Go to Integrations
Find the SSO SAML integration and click Configure
Choose a Default user role, this will be assigned to a user who logs in through SAML Idp SSO but has no assigned role. Here we recommend using a role that hasn't got a lot of permissions (for example the Equipment Viewer role)
Choose where your roles are sourced, this lets you choose if you want to manage the roles from SAML IdP or keep the role management in Cheqroom. More information can be found on the Configure how roles are managed for SSO help article.
Fill in the Domains field, by default, we already add the domain of your email address. In some cases it can be that you have multiple email domains (f.e john@yourcompany1.com and john@yourcompany2.com), then you need to add both domains.
Click Next to proceed to the SAML IdP setup.
Setup SAML IdP
Go to your IdP and add a SAML application for Cheqroom
Most SAML IdP's will immediately provide a metadata file when you are creating a SAML application. but it's also possible that you will first need to add the application before you can download the IdP metadata file. Download Metadata and upload the file on the SAML integration page in Cheqroom
The Service Provider details (ACS URL and Entity ID) can also be copied from the SAML integration page in Cheqroom
Make sure that you configure the following attributes:
nameusernameemail
Also make sure that you return a Name Identifier (NameID) in your SAML response
When you're done adding the application in your IdP, go back to the SAML integration page in Cheqroom and click Enable SSO
Testing SSO
To make sure SSO is working properly, perform these steps:
Log out and close all Cheqroom browser sessions you have open
Enter your email address
You should now be redirected to your SAML IdP login page
Enter your credentials
After entering your credentials, you should be redirected and logged in to Cheqroom.
Configuring Roles
This step is only related if you've chosen that your roles are managed from SAML IdP. More information can be found on the Configure how roles are managed for SSO help article.
Go to the Cheqroom application in your IdP
Add an extra attribute (similar like adding name, email, username):
cheqroom__role
Next you will need to specific the role values on your users. You can copy paste the role values from the SAML integration page in Cheqroom.