For Developers

Adding Your Microsoft OAuth Client

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

Before Getting Started

You must be a Microsoft Entra Administrator to complete the integration process. If you are an admin, please make sure you have access to the App registrations page in your Microsoft Entra Admin Center. If you cannot access that page with your school-assigned Microsoft credentials, you will need to have an administrator with additional privileges perform the integration.

Configuring the Microsoft App Registration in Microsoft Entra's Admin Center

  1. Go to the Microsoft Entra admin center
  2. Search App registrations in the top bar.
Microsoft App Registrations
  1. Click + New registration.
Microsoft App Registrations -> New Registration
  1. Enter a display Name for your application.
  2. Choose the Supported account types that fit your use case. Most likely, "Multiple Entra ID tenants", with the "Allow all tenants" radio button selected.
  3. Set the Redirect URI to: "Web" and https://ed.link/api/authentication/microsoft.
Microsoft App Registrations Form Example
  1. Click the blue Register button at the bottom of the form.

It should redirect you to the newly created App registration where you can see the Application (client) ID along with other details.

  1. Click on the link Client credentials: Add a certificate or secret.
Microsoft App Registration Details Screen
  1. Click + New client secret.
Creating a Client Secret for a Microsoft App Registration
  1. Enter any description you like.
  2. Choose the Expiration you prefer. Remember that you will have to re-create a secret whenever this one expires. Click the blue Add button to save.
Creating a Client Secret for a Microsoft App Registration

Client secret values cannot be viewed, except for immediately after creation. Be sure to save the secret when created before leaving the page.

Save the Value of the newly created secret somewhere secure. You will need the value to configure the client in the Edlink Dashboard.

Optionally, update the logo image for this Microsoft Application Registration in the "Branding & properties" tab. On this tab, you also might want to associate a verified Microsoft Partner Center (MPN) account with your application, if that's necessary for your use case.

Adding / Changing the Microsoft App Registration's Scopes

  1. Go to the Microsoft Entra admin center
  2. Search App registrations in the top bar.
  3. Select your app registration.
  4. Select the "API permissions" sub-tab.
  5. Select + Add a permission.
  6. Search and select the permissions your app requires.
  7. Click Add permissions at the bottom.