User Single Sign On

GET https://webservices.lightspeedvt.net/REST/V1/users/login/{userId}

When would you use this method?

To make it easier for your users to access their training and other LightSpeed VT (LSVT) resources requiring authentication, you can use this method to redirect them to the Training Center without the user having to enter credentials again.

The typical process would follow this flow:

1. Users sign in into your application
2. Users are presented with a CTA link prompting them to proceed with their training
3. Users click the CTA link and are sent to LSVT without being prompted for LSVT credentials

How does this method work?

This method will allow you to first confirm that you're authorized to create a login session on behalf of the user by obtaining a token. Then, using the token you obtained, a URL link with the unique token string is provided for you to use.

How can you implement it?

1. The first required step is for your script/coding to match your application's users with the LSVT's users in order to make sure you will sign in the correct users. The best way is to use the unique userid we provide as the "reference key" to match users data from both applications
2. Your script will need to obtain the token. It is simply done by using GET to the API endpoint https://<LSVT_API_ENDPOINT>/users/{userId}/login
3. Our API will return a full absolute URL containing the token as a string, which would look like https://<LSVT_API_ENDPOINT>/login/authUser.cfm?token=207AD4BAA4498876776A424A3DD92E6DCDB416A5890CA86728EFDD2665A
4. Your script would then need to generate a CTA link or other redirect process to take the user, using the exact URL that is provided in the successful response.

This method uses the User Id as request path parameter. If you do not know the User Id, you may retrieve it by using the User Data by Username method.

After requesting a token, the session it created will be valid for 20 minutes.

How can you redirect a user to a different area of the training center?

There is an option to redirect a user to a different URL within the training center. You simply need to use the URL and append it to the absolute login URL our API returns, by using the parameter dest.

Example: https://<LSVT_API_ENDPOINT>/login/authUser.cfm?token=207AD4BAA4498876776A424A3DD92E6DCDB416A5890CA86728EFDD2665A&dest=https://community.lightspeedvt.com