Add Github login

You can add Github login to your applications using Asgardeo and enable users to log in with their Github accounts.

Follow this guide for instructions.

Register Asgardeo on Github

You need to register Asgardeo as an OAuth app on GitHub.

Note

You can follow the Github documentation for detailed instructions.

1. Log in to Github, click your profile icon, and click Settings.
2. On the left panel of the Settings page, click Developer settings.

3. Under OAuth apps, click Register a new application.

   

4. Give the application a name and the following URLs:

   • Homepage URL

     https://api.asgardeo.io/t/{organization_name}
     

   • Authorization callback URL

     https://api.asgardeo.io/t/{organization_name}/commonauth
     

   

5. Click Register application.

6. Generate a new client secret and take note of the Client ID and Client secret.

Register the Github IdP

Now, let's register the Github IdP in Asgardeo.

1. On the Asgardeo Console, go to Connections.
2. Click New Connections and select Github.

3. Enter the following details and click Finish:

   

   Parameter	Description
   Name	A unique name for this Github identity provider.
   Client ID	The client ID obtained from Github.
   Client secret	The client secret obtained from Github.

4. Go to the Settings tab and see the list of scopes to which Github has granted permissions.

   • email: Grants read access to a user's primary email address.
   • public_profile: Grants read access to a user's default public profile details.

   Note

   Asgardeo needs these scopes to get user information. Asgardeo checks the attribute configurations of the application and sends the relevant attributes received from Github to the app. You can read the Github Documentation to learn more.

Enable GitHub login

Before you begin

You need to register an application with Asgardeo. You can register your own application or use one of the sample applications provided.

1. On the Asgardeo Console, go to Applications.

2. Select your application, go to the Login Flow tab and add Github login from your preferred editor:

   Classic EditorVisual Editor

   To add Github login using the Classic Editor:

   1. If you haven't already defined a sign-in flow, click Start with Default configuration to get started.

   2. Click Add Authentication on the step, select your Github identity provider, and click Add.

      

   To add Github login using the Visual Editor:

   1. Switch to the Visual Editor tab, by default the Username & Password login flow will be added onto the Visual Editor's workspace.

   2. Click on + Add Sign In Option to add a new authenticator to the same step and select your Github connection.

      

   ---

   Recommendations

   It is recommended to add your social and enterprise connections to the first authentication step as they are used for identifying the user.

3. Click Update to save your changes.

Try it out

Follow the steps given below.

1. Access the application URL.

2. Click Login to open the Asgardeo login page.

3. On the Asgardeo login page, Sign in with Github.

   

4. Log in to GitHub with an existing user account.

Note

When a user successfully logs in with Github for the first time, a user account is created in the Asgardeo Console with the Github username. This new user account will be managed by GitHub.

Configure connection

To learn more about other configurations available for the connection, refer to the add federated login documentation.