In addition to SAML (Security Assertion Markup Language), LearnWorlds supports OpenID for implementing seamless SSO (Single Sign-on) experiences. By utilizing SSO, users can access multiple systems with a single set of login credentials, significantly enhancing security and user convenience.
In this article, we will dive into how to integrate Xero with LearnWorlds using OpenID, simplifying your user access and streamlining your platform's security. Below you can find a step-by-step guide on how to set this up.
1. Navigate to https://www.xero.com/ and log in to your developer account or create a new one.
2. Go to My Apps and create a new app.
3. Choose your app’s name, Web app as your integration type and fill in your school’s URL under the Company or application URL.
You also need to locate the redirect URI and paste that on the last field. You can find the redirect URL in your LearnWorlds school by following these steps:
- Go to your LearnWorlds school, and navigate to Website → Website Settings → Authentication → Open ID connect and create a new OpenID connect. Locate the Redirect URL and copy it.
Navigate back to Xero and paste the Redirect URL inside the Redirect URI field. Once all the fields everything are completed click on the Create app button.
4. Navigate to your LearnWorlds school and:
- Locate your privacy and terms pages by navigating to Website → Design → Edit Website.
- Copy the URL of the page; it should look like {yourdomain}.learnworlds.com/privacy and {yourdomain}.learnworlds.com/terms.
Navigate back to your Xero dashboard on the App details tab, where you need to fill in the Privacy URL copied from your LearnWorlds school.
5. Move to the configuration tab, click on copy client ID, and generate a secret.
6. Paste the Client ID and Secret inside your LearnWorlds school into the new Open ID connect you created under Client ID and Client Secret.
7. Copy the link we provide: https://identity.xero.com/.well-known/openid-configuration; paste it on the Discovery Document link field, and click on the Fetch button.
8. In the Scopes field, paste openid email profile, ensuring each scope is separated by a space.
If you're using OpenID as an authentication method, it's mandatory to change the Site Navigation settings in the Payment Flow section for Logged-out users, as they will need to sign up/log in before proceeding to the payment page.
Also, you need to ensure that in all Payment Sections of your school's pages, 1-click Sales funnels, or the Payment Page of your school, the Sign in/up form option is set to hide since the user will not be able to sign in/up via the Learnworlds system.
- If you set up an SSO solution and disable the LearnWorlds login, all the users will be redirected to the SSO provider to authenticate, LearnWorlds passwords will no longer be valid. The users need to exist or sign up with the SSO authentication provider. The change of the authentication provider will only change the authentication mechanism, all the user data as well as their roles (admin, instructor, etc.) will be intact.
- The SSO mechanism uses the user’s email address to identify the user (unique key); therefore, to change the user's email address, you need to manually update the new email both in your school and on your IDP.
Furthermore, you may use the bulk import (and enroll) functionality in case you need to import users that already exist in your SSO provider.
- If you revert to LearnWorlds authentication, users created via the SSO authentication will need to create a new password. Passwords can be changed:
- By the user via the forgot password mechanism
- By the admin reset and/or update password mechanisms
- The LearnWorlds password update/reset functionality as well as sign-up are only available for the Default LearnWorlds Authentication mechanism. Any other SSO authentication mechanisms will need to handle these functionalities.
- In case you misconfigure the custom SSO setup and this is the only available authentication mechanism, then only the Learnworlds School Owner account will be able to sign in to your school via our Learnworlds account sign-in page (https://account.learnworlds.com/login)
- The built-in Affiliate Management program can not be used for users who use SSO providers to sign in
- If you want to use more than three custom SSO, SAML, or OpenID solutions in total, please contact us at support@learnworlds.com. In case you are on the Learning Center plan you can also add 3 more by purchasing our scale package.