providers/github

Built-in GitHub integration.

default()

Add GitHub login to your page and make requests to GitHub APIs.

Setup

Callback URL

https://example.com/api/auth/callback/github

Configuration

import { Auth } from "@auth/core";
import GitHub from "@auth/core/providers/github";

const request = new Request(origin);
const response = await Auth(request, {
  providers: [
    GitHub({ clientId: GITHUB_CLIENT_ID, clientSecret: GITHUB_CLIENT_SECRET }),
  ],
});

Resources

• GitHub - Creating an OAuth App
• GitHub - Authorizing OAuth Apps
• GitHub - Configure your GitHub OAuth Apps
• Learn more about OAuth
• Source code

Notes

By default, Auth.js assumes that the GitHub provider is based on the OAuth 2 specification.

tip

The GitHub provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer

If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

default(config: OAuthUserConfig<GitHubProfile>): OAuthConfig<GitHubProfile>

Parameters

Parameter	Type
config	OAuthUserConfig<GitHubProfile>

Returns

OAuthConfig<GitHubProfile>

---

GitHubProfile

See

Get the authenticated user

---