GitHub login

To enable users to log in with GitHub, first activate GitHub login in the builder and then set up an application with GitHub to serve as the OAuth provider.

Follow these steps for a smooth integration.

Enabling GitHub login in builder

1. Navigate to Home and open the Login Box builder.
2. In the left panel, toggle GitHub to on.

Creating a GitHub app

Complete the following steps to configure GitHub login.

Step 1: Register an application

1. In your GitHub account, navigate to Organization Account Settings.

2. Go to Developer settings ➜ OAuth Apps.

3. Click New OAuth App and fill in the application name and details. For the callback URL, enter your application URL (use your Frontegg domain if using hosted login or your app domain if using embedded login), followed by /account/social/success.

Step 2: Generate credentials

Once your application is created, you will be redirected to the application configuration screen.

1. Under Client secrets, click Generate a new client secret and save the generated secret.

Step 3: Enter credentials in Frontegg

1. Go to [ENVIRONMENT] → Authentication → Social Logins.

2. Click the GitHub manage button.
3. Enter your GitHub Client ID, Client Secret, and Redirect URL, then save and publish.

Step 4: Test the GitHub login button

1. On your login screen, verify that the GitHub button appears and redirects to the GitHub OAuth consent screen for login.

2. Test to confirm functionality.

Customizing authentication scopes for GitHub

Scopes specify the type of information your application can access after users grant permission. The generated access token will include these approved scopes. By default, Frontegg fetches user profile and email as the standard scopes when users authenticate via their GitHub account.

To add additional custom scopes, navigate to [ENVIRONMENT] → Authentication → Social logins → Custom → Scopes on the Frontegg portal. You can check GitHub's supported scopes here.