For Developers

Adding Your Google OAuth Client

This guide will help you configure your own Google OAuth client to customize the Google consent screen experience. By setting up your own OAuth client, your users will see your application's title and logo on the Google consent screen instead of Edlink's branding, providing a more seamless and branded experience.

Before Getting Started

You must be a Google Administrator to complete the integration process. If you are an admin, please make sure you have access to the App Access Control page in your Google Admin Console. If you cannot access this page with your school-assigned Google credentials, you will need to have an administrator with additional privileges perform the integration.

Accessing Google Auth Platform in Google Cloud Console

  1. Go to Google Auth Platform / Clients
Google Connection Screen
  1. Click on the "Create client" button
Google Connection Screen
  1. Fill out the creation form
    1. Application type: Web application
    2. Click on "Add URI" in the "Authorized JavaScript Origins" section and add https://ed.link
    3. In the "Authorized redirect URIs" section, add two URIs:
      • https://ed.link/api/authentication/google
      • https://ed.link/api/authentication/google/anonymous
Google Connection Screen
  1. Click on the "Create" button at the bottom of the form
  2. A secrets window will pop up. Copy the Client ID and the Client Secret, store them in a secure place, and DO NOT share them with anyone. You can also use "Download JSON" to store all of the credentials.
Google Connection Screen
If you lost your secrets, or they were exposed, you can always revoke the exposed secrets and create new ones on the Client's details page in the "Additional information" section.

Adding / Changing the Client's scopes

  1. Go to Google Auth Platform / Data access
  2. Click on the "Add or remove scopes" button
Google Connection Screen
  1. In the panel that appears on the right side, check these scopes:
    • openid
    • .../auth/userinfo.email (Google's equivalent for OpenID's email)
    • .../auth/userinfo.profile (Google's equivalent for OpenID's profile)
Google Connection Screen
  1. If you need additional scopes, check them as well and remember them. You will need to provide them when setting up Edlink's Data Provider.
  2. Click on the "Update" button

Setting up Google Provider in Dashboard

  1. Go to "Data Providers" page of your team on Edlink's Dashboard
  2. Find "Google" and click on "Configure"
Google Connection Screen
  1. In the panel on the right side, enter your Google OAuth Client ID and the Client Secret
Google Connection Screen
  1. If you added additional scopes beyond openid, .../auth/userinfo.email, and .../auth/userinfo.profile, you should add them in the "Additional scopes" field
Google Connection Screen

Well done!

You're now finished—well done! Your school's info will appear in the dashboard within 24 hours. This includes teacher and student names.

Any Questions?

If you still have questions, please contact our support team and we'll get back to you within 24 business hours.