Learn how to configure Single Sign-On (SSO) integration using SAML 2.0, OpenID Connect, or JWT to streamline login processes and enhance security for your vFairs events.
Overview
Single Sign-On (SSO) is a secure authentication mechanism enabling users to access multiple applications and services with a single set of credentials. By authenticating once through a trusted Identity Provider (IdP), users gain seamless access to all connected systems, reducing the need to manage multiple login credentials while enhancing security and user convenience.
- For the JWT protocol, refer to the instructions provided in this sub-article
- For the OpenID Connect protocol, contact your event project manager to coordinate a custom implementation with the engineering team.
- For the SAML 2.0 protocol, follow the step-by-step instructions below.
Step 1: Obtain vFairs Event Metadata File
To obtain the vFairs event-specific metadata file, please follow these steps:
- Log in to the event backend as an admin.
- Navigate to Event Setup >> General Settings >> Advanced Settings >> SAML Config section.
- Click on the Download Metadata File link to access the event-specific metadata file.
Step 2: Configure vFairs Application in the Identity Provider (IdP)
Set up the vFairs application within the Identity Provider (IdP). For the purposes of this documentation, we will use Entra ID SAML (formerly known as Azure AD) for the SSO configuration. Please follow the instructions provided in this sub-article
Step 3: Add IdP Metadata SSO Settings in vFairs Event
The next step involves entering the IdP metadata file details into the vFairs event configuration to establish a secure SAML connection between vFairs, acting as the Service Provider (SP), and the Identity Provider (IdP).
Navigate to Event Setup >> General Settings >> Advanced Settings >> SAML Config section.
|
Field Names |
Description |
|
Enable Frontend SSO (Mandatory) |
Toggle this on to activate SP-initiated SSO workflow, allowing users to log in to the event website. |
|
Entity ID (Mandatory) |
Copy the Entity ID value from the IdP metadata file and paste it here, ensuring no leading or trailing spaces. |
|
Single Sign On URL (Mandatory) |
Copy the SingleSignOnURL from the IdP metadata file and paste it here, ensuring no leading or trailing spaces. |
|
Single Logout URL (Mandatory) |
Copy the SingleLogOutURL from the IdP metadata file and paste it here, ensuring no leading or trailing spaces. |
|
Certificate Frontend (Mandatory) |
Copy the <x509 Certificate> from the IdP metadata file and paste it here, removing the ---BEGIN CERTIFICATE--- and ---END CERTIFICATE--- lines, ensuring no leading or trailing spaces. |
|
First Name, Last Name, and Email Address (Mandatory) |
Copy the claim/attribute values for First Name, Last Name, and Email from the IdP metadata and paste each into its respective text box, ensuring no leading or trailing spaces. |
|
Use Registration Fields (Optional) |
Toggle on if additional user claim/attributes are needed. Click Add Field to select the appropriate vFairs fields from the dropdown. Copy the corresponding claim name from the IdP metadata and paste it here, ensuring no leading or trailing spaces. |
|
Disable Force Auth (Optional) |
Toggle this on to allow a true SSO experience, bypassing credential prompts for users already logged into another IdP application, logging them into vFairs automatically. |
|
Disable Auto-Provisioning (Optional) |
Toggle this on if you do not want to grant default access to the vFairs event upon SSO login. This applies when event registration is mandatory and access should not be given to every user within the IDP. |
|
Redirect User to Registration Form (Optional) |
Toggle this on along with "Disable Auto-Provisioning" to redirect users to the vFairs event registration page, where their First Name, Last Name, and Email Address will be pre-populated for registration completion. Once the registration period ends, disable this toggle only to grant users access to the event upon SSO login. |
|
Enable Multi-Event Users Login (Optional) |
Toggle this on to enable organization-level SSO for all events, eliminating the need to configure SSO separately for each event. Registration is mandatory for this SSO workflow across all events within the organization. If a user is registered for multiple events, an event listing page will appear upon SSO login, allowing them to select and access the desired event. Otherwise, if the user is registered for only one event, they will be logged in directly. |
|
Enable Debugging (Optional) |
Toggle this on to display the SAML assertion response on the screen after IdP credential verification. This helps in assessing and finalizing SSO configurations, particularly claim/attribute mapping with vFairs data placeholders. |
|
Single Sign-On URL Mobile (Optional) |
Add the mobile SSO URL in this format: https://youreventurl/en/mobile_sso?redirect_to=youreventSSOURL. Users will enter the Company SSO Code and be redirected to the IdP login screen to access the event within the app. |
|
Company SSO Code (Mobile, Optional) |
Add the Event Access Code as the Company SSO Code for mobile app SSO login, allowing users to proceed to the IdP login screen after entering the code. For white-label apps, users can access the IdP login screen without entering the code. |
|
Event SSO URL |
Once SSO configurations are completed, your event SSO URL will follow this format for mapping on the landing page or direct access for testing: https://youreventurl/vfair/saml/event/dev/?sso. |
If your event does not include a mobile app, please leave the Single Sign-On Mobile URL and Company Code fields blank.
Step 4: No IdP? Provide SSO-like Experience with Unique Links for End Users
Upload your non-SSO participants via CSV, and vFair's email scheduler will automatically send sign-up emails to each user, containing unique event access links, enabling one-click event access.
- Log in to the event backend as an admin.
- Go to Participants >> Attendees & Registrants >> click Import >> select Download Template >> download the Attendee Template.
- Add user details to the downloaded attendee template, then import the completed CSV file.
- Map the fields and complete the CSV import process.
- Once the users are successfully created within vFairs, personalized sign-up emails can be sent to their email addresses, containing unique magic links for one-click event access.
For personalizing your sign up emails with unique login links of the registrants please contact your assigned Project Manager for assistance.
