{"hash":"github","items":[{"hash":"0","content":"

Connect Apps to GitHub

\n

The GitHub social connection allows users to log in to your application using their GitHub profile.

\n

By default, Auth0 automatically syncs user profile data with each user login, thereby ensuring that changes made in the connection source are automatically updated in Auth0. Optionally, you can disable user profile data synchronization to allow for updating profile attributes from your application.

\n"},{"hash":"1","content":"

Prerequisites

\n

Before you begin, sign up for a GitHub Developer account.

\n"},{"hash":"2","content":"

Steps

\n

To connect your app to GitHub, you will:

\n
    \n
  1. Set up app in GitHub
    2. \n
  2. Create and enable connection in Auth0
    3. \n
  3. Test connection
    4. \n
\n"},{"hash":"3","content":"

Set up app in GitHub

\n

Register a new app in GitHub Developer Settings: OAuth Apps. During this process, GitHub will generate a Client ID and Client Secret for your application; make note of these.

\n

While setting up your app, use the following settings:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldValue to Provide
Homepage URLhttps://{yourDomain}
Authorization callback URLhttps://{yourDomain}/login/callback
\n
\n

Find your Auth0 domain name

\n
\n
\n

If your Auth0 domain name is not shown above and you are not using our custom domains feature, your domain name is your tenant name, your regional subdomain (unless your tenant is in the US region and was created before June 2020), plus.auth0.com. For example, if your tenant name were exampleco-enterprises, your Auth0 domain name would be exampleco-enterprises.us.auth0.com and your callback URL would be https://exampleco-enterprises.us.auth0.com/login/callback. (If your tenant is in the US and was created before June 2020, then your domain name would be https://exampleco-enterprises.auth0.com.)

\n

If you are using custom domains, your redirect URI will have the following format: https://<YOUR CUSTOM DOMAIN>/login/callback.

\n
\n"},{"hash":"4","content":"

Create and enable connection in Auth0

\n

Set up the GitHub social connection in Auth0. Make sure you have the generated Client ID and Client Secret.

\n"},{"hash":"5","content":"

Test connection

\n

You're ready to test your connection. After logging in, you'll be prompted to allow your app access. To do so, click Install unlisted app.

\n"},{"hash":"6","content":"

Troubleshooting

\n

If you are receiving Access Denied when calling the GitHub API, you probably have not requested the correct permissions for the user during login. To learn more, see Add scopes/permissions to call Identity Provider's APIs.

\n"}]}