Synap Academy
Synap Home
  • ๐Ÿ‘‹Hello there
  • ๐Ÿ†•What's new
    • Big features
      • โณLimit membership duration for user groups
      • โ“Question based marking
      • ๐Ÿ‘ฝCloze questions & new editor
      • ๐Ÿฆ„Customise questions in exams
      • ๐Ÿคธโ€โ™‚๏ธFlexi retakes
      • ๐Ÿ’ฟRecords of learning
      • ๐Ÿ‡Override attempt scores, comments & history
      • ๐ŸงชLab values / Additional exam resources
      • ๐Ÿ”–Bookmarking
      • โœ๏ธSingle Sign On (SSO)
      • ๐ŸŽSub portals
      • ๐Ÿ›‚Multi-factor Authentication (MFA)
      • ๐Ÿ—’๏ธNotepad on attempts
      • ๐Ÿ‘๏ธโ€๐Ÿ—จ๏ธSynoptic
      • ๐ŸŽ–Override Grades
      • ๐Ÿ“ธGet webcam shots for identity verification
      • ๐Ÿ”Exam security: Lock exam attempts
      • โ›“๏ธShare links
      • ๐Ÿ›ฉ๏ธThe attempts table
      • ๐Ÿ“‹Anti cheat: disable copy & paste
      • ๐ŸฆšStudents Insights page
      • ๐Ÿงžโ€โ™‚๏ธGenerating quizzes
      • ๐Ÿฅ‡Exam certificates & resits
      • ๐Ÿ” Mark schemes/rubric marking
      • โœ…Marking & definition of completed attempts events -
      • ๐Ÿ‘ฏโ€โ™€๏ธCloning
  • ๐ŸŽฎInteractive demos
  • ๐Ÿƒโ€โ™‚๏ธGetting started
    • Overview
    • Content management
      • Notes
        • Dynamic notes
      • Surveys
      • Uploading content
        • Embed presentations
    • Billing & usage
  • โ“Quizzes
    • Creating a Quiz
      • Question types
        • Cloze question types
        • Audio recording questions
        • Audio/Video Stems and configurations
      • EMQs
      • Quiz Experience
      • Instructions & sections
      • Scoring on Synap (Points vs Credits)
        • Negative Scoring
        • Score by choice
    • Importing & Exporting Questions
      • Importing
        • Word Doc to CSV Format
        • Questions
        • EMQs
        • Sections
      • HTML formatting
  • ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘ฆโ€๐Ÿ‘ฆUsers & Groups
    • User types
    • Creating groups
      • Adding & inviting users by email
      • Generating user accounts
      • Importing new and existing users via csv
      • Customising messages to users
      • Sharing user group links
      • Advanced group settings
    • Manage groups
    • User information
    • Permissions
      • Global permissions
      • Specific permissions
      • Educator permissions
      • Markers permissions
  • ๐Ÿ‘จโ€๐Ÿ’ปExams
    • Understanding Exams on Synap
    • Create and Manage Exams
      • ๐Ÿ—๏ธ1. Setup: Exam
        • Dynamic exams
        • Customisation
      • ๐Ÿ”จ2. Build: Exam
        • Sections
        • Grades
      • โš™๏ธ3. Configure
        • Experience
        • Instructions
        • Results
        • Resits
        • Certificates
      • ๐Ÿš€4. Advanced
      • ๐Ÿ–‹๏ธMarking - Double & Blind
        • Adding custom marks & a mark scheme
      • ๐Ÿ“จ5. Share
        • Schedule
        • Publishing
        • Versioning
      • ๐Ÿ‘€6. Manage
    • Mark/Score attempts
    • Anti-Cheat features
      • Disabling Spellcheck for Exams
    • Proctoring
      • Proctoring with Rosalyn
        • Rosalyn Lock-down exam
        • Rosalyn Live Proctoring exam
        • Sitting a Rosalyn Proctored exam
      • Proctoring with Synoptic
        • Create a Synoptic exam
        • Reviewing Synoptic Sessions
        • Sitting a Synoptic Proctored Exam
        • Synoptic Best Practices & Trouble Shooting
      • Proctor Pricing
  • ๐Ÿ„Collections
    • Creating collections
      • Configure collections
    • Manage user group visibility
    • Collection mocks
    • Collections and the Study
    • Collection use cases
  • ๐ŸŽ๏ธCourses
    • Assignments
    • Course builder
    • Assigning a course
      • Viewing assignments & publishing new versions
    • Courses and assignment use cases
  • โš™๏ธPortals
    • Trouble shooting for your students
    • Portal Settings
      • General and branding
      • Registration settings
      • Email settings
      • Locale / Language settings
      • SSO Authentication
        • Auth0
        • JSON Web Tokens (JWT)
        • SAML with Okta (EU)
        • SAML with Okta (US)
      • Study and Self Practice settings
    • User Access
    • Data Management
      • Tag manager
      • Attributes
      • Records of learning
    • Sub portals
      • Creating sub portals
      • Branding sub portals
  • ๐Ÿ“ŠAnalytics
    • Fractal
    • Tags & facets
      • Facet best practice
    • Student Insights
    • Question statistics
  • โฌ…๏ธExports & Reporting
    • Attempts table & exports
    • Reporting platform (Depreciated)
    • Flag exports
  • ๐Ÿ”ŒIntegrations
    • ๐ŸชWebhooks
      • User Updated Webhook
      • Attempt Completed Webhook
      • Attempt override created
      • User Registered Webhook
      • Exam Completed Webhook
      • Attempt Submitted Webhook
      • Exam Submitted Webhook
      • Attempt Certificate Generated
      • Store Purchase Webhook (Legacy)
      • Completed Assignment Webhook
      • Flag Planted Webhook
      • User Added to User Group Webhook
      • User Registered for Exam Webhook
      • Learning Record Webhooks
      • Invite sent
    • Integrations & APIs
    • Single Sign On
    • โšกZapier
      • ๐ŸŸขGet started
      • ๐Ÿ”ซTriggers
      • ๐ŸŽฌActions
      • ๐Ÿ—๏ธExample Workflows
    • Segment
      • Test & Question Analytics
    • Google Analytics
    • Custom Domain (CNAME)
    • Synap Mobile apps
  • ๐Ÿš€Using Synap
    • Admin Account
    • Synap Students
Powered by GitBook
On this page

Was this helpful?

  1. Portals
  2. Portal Settings
  3. SSO Authentication

Auth0

Guide to Setting Up SSO with Auth0

PreviousSSO AuthenticationNextJSON Web Tokens (JWT)

Last updated 13 hours ago

Was this helpful?

A flexible, drop-in solution to add authentication and authorisation services to your applications. Auth0 is often categorised as Identity-as-a-Service (IDaaS) and is a cloud-based solution. It offers a range of services, including but not limited to, single sign-on, multi-factor authentication, password-less login, and user management. Benefits of Auth0:

  1. Platform Agnostic: Unlike ADFS, Auth0 is not tied to any specific operating system or suite of tools. This makes it highly versatile and suitable for a wider range of applications.

  2. Cloud-Based: As a cloud-based service, it's easier to scale and has lower upfront costs compared to a self-hosted solution like ADFS.

  3. Feature-Rich: Auth0 offers a host of features, including social login options, multi-factor authentication, and breach detection.

You'll need to create an Auth0 account before you can set up SSO on your Synap platform, head over to to learn more and get started for free.

US Infrastructure is a Synap Enterprise only feature, please note if you are based in the US you are not automatically moved to US infrastructure and will need to use EU links in your set up.

EU Infrastructure Callback URL:
https://api.synap.ac/external-auth/auth0/authenticate
US Infrastructure Callback URL:
https://use1.prod.api.synap.ac/external-auth/auth0/authenticate

1. Create an application in Auth0

Follow the steps in Auth0's to create an application. You'll need to go to applications, create application. Make sure you create a Regular Web Application.

When you create the application, there is an option to give more details but you can ignore this and go to settings to get the information you need to put back into Synap.

From the Settings>Authentication page, add a new connection, select Auth0 as the authentication method. Give the configuration the appropriate label (what your users will see on the button on the login page) and a name.

You will now need to go back to your application on Auth0 and get the following information:

  • Domain

  • Client ID

  • Client secret

Copy each of these and put them back into Synap and save.

From the Auth0 settings page for your application you can also upload a logo and add in the different connections you want to use, once done save your changes. Now open your connection on Synap, you need to get the Callback URL to put into Auth0 in the Settings>Application URIs>Allowed Callback URLs and save

Once all this is done you can save and enable the connection on Synap.

From here you SSO is ready to go, in Auth0 you can select from predefined connections and enable them right away (Google, Facebook, Microsoft) or add in your own custom one.

You may need to setup your admin account as a user on Auth0 if you're going to disable local login. Using the main menu, navigate to users and create a user with the same email you use to login to Synap with.

โš™๏ธ
More in Auth0 docs
https://auth0.com/
documentation
Auth0 Applications page
Select Regular Web Application in Auth0
Synap adding a new SSO configuration
Copy over the details from Auth0 to Synap
Getting the callback URL into Auth0
enabling an Auth0 connection
Creating a user in Auth0