The Vygo platform supports SAML 2.0 integration to allow your users to sign in using your organisation's authentication provider.

Getting started

To get started, you can download a copy of our metadata file here:

🚧
Configuring your IdP
If you are unsure of how to get your metadata file or configure your IdP please reach out directly to your provider or refer to their documentation.

Configuring your IdP (Part 1 - Using Vygo Metadata)

Once you have downloaded our metadata file, you will need to configure Vygo in your IdP.

If your IdP has the option to import a metadata file, this should be fairly straightforward. Otherwise, you will need to open the metadata file to copy out the relevant information into the appropriate fields.

Please then email a copy of or link to your IdP metadata to engineering@vygoapp.com.

We will take care of the configuration in the Vygo platform on your behalf.

Configuring your IdP (Part 2 - Unique Identifier & Attribute Mapping)

When a user signs into the Vygo platform using SSO, we require a few pieces of information to create a new account.

Unique Identifier
NameID: This must be the user's unique immutable email address. Preferably studentID@domain as this email generally will never change.

Attribute Mapping
Please set the bold text below as the FriendlyName when configuring mapping. This allows the Vygo platform to utilise the values from the SAML Assertion.

fName: User's first name
lName: User's last name
email: The same email address used for the NameID.

Testing Connection

We will send you a link to test the connection.

Once confirmed, we will enable SSO authentication in the Vygo platform, and you will be able to complete a final test at https://web.vygo.app.