Skip to main content
Version: v4

GitHub

note

GitHub returns a field on Account called refresh_token_expires_in which is a number. See their docs. Remember to add this field to your database schema, in case if you are using an Adapter.

Documentation

https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps

Configuration

https://github.com/settings/apps

Options

The GitHub Provider comes with a set of default options:

You can override any of the options to suit your own use case.

Example

import GitHubProvider from "next-auth/providers/github";
...
providers: [
  GitHubProvider({
    clientId: process.env.GITHUB_CLIENT_ID,
    clientSecret: process.env.GITHUB_CLIENT_SECRET
  })
]
...
warning

Only allows one callback URL per Client ID / Client Secret.

tip

Email address is always returned, even if the user doesn't have a public email address on their profile.