What Is the Single Sign-On (SSO) Feature & How Does It Work?
Single Sign-On (SSO) lets your quiz automatically identify users who are already logged into your website. This feature is used when you have embedded a quiz on your site or when you have information about the user, such as their name, email id, user id, and password that you wish to pass to the quiz. That way, the quiz taker does not need to enter their name, email id, user id, or even the password to access the quiz, as these are automatically identified.
Why is Single Sign-On Required?
This feature is useful when you have many users who have already logged in to your website or you have information on a large number of users. By using Single Sign-On, users are automatically identified by the quiz (without the user being asked for their name, email id, user id, password, etc.), and when as the quiz author, you review the report, you would see who took your quiz. This prevents quiz takers from re-entering their information each time to take the quiz and makes the overall system more secure as users are identified by the system rather than trusting the user to enter the correct identifying information.
Integrating SSO When You Link to Quizzes Hosted At ProProfs.com When you link to quizzes that ProProfs is hosting for you, you can pass the following variables to the URL:
- user_name - for username
- user_email - for the user's email address
- user_id - for user's ID (this variable will remain the same even if you have renamed ID)
- passkey - for MD5 encrypted password
- cq_xxxxxxx (SSO Key) - An SSO Key is associated with a custom question you can create.
Integrating SSO When You Embed Quizzes On Your Website
Let's take an example of your website URL (link) where you have embedded the quiz.
We use the following variables from the query string to fetch the user data from the query string. These are
- user_name - for username
- user_email - for the user's email address
- user_id - for user's ID (this variable will remain the same even if you have renamed ID)
- passkey - for MD5 encrypted password
- cq_xxxxxxx (SSO Key) - An SSO Key is associated with a custom question you can create.
You need to provide these variables with the quiz URL/iframe source where you embedded the quiz.
For example:
You have embedded the quiz on the website page: http://www.mywebsite.com/quiz/page.html
Then add variables in URL/ iframe src:
What is Passkey?
Passkey is an option to allow authorized users to access password-protected quizzes without any password requirement.
If you have trouble implementing the SSO on your website, please contact support for assistance.
An SSO Key is attached to a custom question. When you create a custom question, the key is generated automatically. Furthermore, the SSO Key is updated every time you change its corresponding question, no matter how big or small.
Here's how you can create a custom question to get an SSO Key:
Step 1: Go to a quiz's Settings >> Security.
Step 2: Scroll to the option Ask My Own Question and enable it. You can then add the following question types:
- Choose from list
- Write in textbox
- Multiple Choice
Step 3: Enter the question and its answers. Save when you're done, and you can see the SSO Key at the bottom of the question, as shown in the screenshot below. You can similarly add more questions.
Related Articles:
ProProfs REST API Guide
How To Auto-enroll Learners To Classroom Using API
How To Track Progress Of Learners In My Systems Using API