What can we help you with?
Single sign-on (SSO) for your courses

Learn how to set-up the single sign-on for your learners.

Written Valera Kontsedailo

1. Embedding / integrating courses using LTI (Learning Tools Interoperability specification)

Here is a separate article about LTI (Learning Tools Interoperability specification) and how to use it with Easygenerator courses.

2. SSO (Single Sign-on) via oAuth 2.0 in courses

oAuth 2.0 is a very popular open standard for token-based authentication and authorization.

SSO via oAuth 2.0 is available for an additional fee, please contact us for more info.

Here is a separate article about oAuth 2.0

3. Using URL parameters

Note: This method works in the All-in-one and Simple course templates only when the “save progress cross-device” setting is disabled (certificates are unavailable while cross-device progress saving is off). If the “save progress cross-device” is enabled – please use the progress storage API (the 2nd chapter of this article).

URL parameters

If you want to get rid of the log-in screen but still register the users’ results, you can create a personalized link to the courses you’ve created.

Default URL of the course looks this way:

https://elearning.easygenerator.com/d8dcb950-400f-437f-92ad-787e941ca2e9

To create a personalized link, you need to add the learners’ name and email to the default link in the address bar. The URL with learners’ credentials will look this way:

https://elearning.easygenerator.com/d8dcb950-400f-437f-92ad-787e941ca2e9/?name=John&email=testua92@gmail.com#

4. Using the Progress storage API

Note: This method works in the All-in-one and Simple course templates only when the “save progress cross-device” setting is enabled. If the “save progress cross-device” is disabled – please use the URL parameters method.

Progress storage API

If you want to get rid of the login screen but still register the users’ results and to give your users an option to continue from the place they left off, there is Easygenerator progress storage API.

Below you will find the following API details:

  • Register a new user API method
  • Get a new token API method
  • How to use a token

Register a new user

POST https://progress-storage.easygenerator.com/user/register

Request content type: application/json

Request body parameters:

  • email: User’s email;
  • name: User’s name;
  • password: User’s password;
  • shortTermAccess: true or false.

Example:

{
“email”: “user@mail.com”,
“name”: “user”,
“password”: “abc123$”,
“shortTermAccess”:”true”
}

Response body parameters:

  • token: Token, which allows to log-in (tokens are valid for 24 hours from the moment of the generation).

Get a new token

POST https://progress-storage.easygenerator.com/user/signin

Request content type: application/json

Request body parameters:

  • email: User’s email
  • password: User’s password

Response body parameters:

  • token: Token, which allows to log in

How to use a token

A token can be pushed to a query string. Use the following URL template to log in a user to a course and have his/her progress restored:

[courseLink]?token=[token]

Note: Tokens are valid for 24 hours from the moment of the generation. When a token expires, a new one can be generated using the get token (login) API.

Check if the user exists

POST https://progress-storage.easygenerator.com/user/exists

Request content type: application/json

Request body parameters:

  • email: User’s email

Response body parameters:

  • 204: User doesn’t exist
  • 409: User exists

Send forgotten password link

POST https://progress-storage.easygenerator.com/user/forgotpassword

Request content type: application/json

Request body parameters:

  • email: User’s email

Response body parameters:

  • 200: Email have been sent

Note: In the Test (Assessment) template you can set up the single sign-on via URL only.