Integrations
      Back to home
      1. Help Center
      2. Integrations

      How to configure single sign-on (SSO) integration

      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 # 01: Obtain vFairs Event Metadata File


      To obtain the vFairs event-specific metadata file, please follow these steps:

      1. Log in to the event backend as a super administrator.
      2. Navigate to Event Setup >> General tab >> Advanced Settings >> SAML Config section.
      3. Click on the Download Metadata File link to access the event-specific metadata file.


        Step # 02: 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 # 03: 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 tab >> Advanced Settings >> SAML Config section.





        Field Names

        Description

        Enable Frontend SSO (Mandatory)

        Toggle 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 values for First Name, Last Name, and Principal Name 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 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 on to allow a true SSO experience, bypassing credential prompts for users already logged into another IdP application, logging them into vFairs automatically.

        Redirect User to Registration Form (Optional)

        Toggle on to redirect users to the vFairs registration form upon login, with First Name, Last Name, and Email Address pre-populated. Once the registration period is over, disable this toggle for automatic login.

        Enable Debugging (Optional)

        Toggle on to output the SAML assertion response on the screen after IdP credential verification, assisting in the assessment and finalization of SSO configurations.

        Company SSO Code (Mobile, Optional)

        Enter the Organization Name as the Company SSO Code for mobile app SSO login.

        Single Sign-On URL Mobile (Optional)

        Enter the mobile SSO URL in this format: https://youreventurl/en/mobile_sso?redirect_to=URLEncode. Users will enter the Company SSO Code and be redirected to the IdP for mobile login.

        Finalizing and Testing Your SSO Integration

        Once SSO configurations are updated, your event SSO URL will be accessible for testing: https://youreventurl/vfair/saml/event/dev/?sso.

        Tips: If your event does not include a mobile app, please leave the Single Sign-On Mobile URL and Company Code fields blank.


        Step # 04: No IdP? Provide SSO-like Experience with Unique Links for End Users


        Upload your non-SSO participants via CSV, and vFairs' email scheduler will automatically send sign-up emails to each user, containing unique event access links, enabling one-click event access.


        1. Log in to the event backend as a super administrator.
        2. Go to Participants >> Attendees & Registrants >> click Import >> select Download Template >> download the Attendee Template.
        3. Add user details to the downloaded Attendee Template, then upload the completed CSV file.
        4. Map the fields and complete the CSV upload process.




        5. Once the users are successfully created within vFairs, personalized sign-up emails will be sent to their email addresses, containing unique magic links for one-click event access.

        End-User SSO Login Process Flow Diagram