OIDC (OpenID Connect)

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

🚧
Configuring your IdP
If you are unsure of how to get this information from your provider, please reach out directly to them or refer to their documentation.

Configuring Your OIDC Provider (Part 1 - Required Information)

Please provide the following details to engineering@vygoapp.com.

Client ID: Your OAuth 2.0 client identifier
Issuer URL: Your OIDC provider's issuer URL (e.g., https://auth.uni.edu)

Callback URL

You will need to add the following redirect URI to your OIDC provider's allowed callback URLs list:

https://web.vygo.app/__/auth/handler

Configuring Your OIDC Provider (Part 2 - 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

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

Attribute Mapping

Please ensure the following claims are included in the ID token:

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

Testing Connection

We will send you a link to test the connection.

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