Skip to main content

Function: default

providers/github.default

â–¸ default<Profile>(options): OAuthConfig<Profile>

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

Example​

Example

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

const request = new Request("https://example.com")
const resposne = await AuthHandler(request, {
providers: [
GitHub({clientId: "", clientSecret: ""})
]
})

Resources​

See


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.

Type parameters​

NameType
Profileextends GithubProfile<Profile>

Parameters​

NameType
optionsOAuthUserConfig<Profile>

Returns​

OAuthConfig<Profile>