Skip to main content

Providers

Authentication Providers in NextAuth.js are services that can be used to sign in a user.

There's four ways a user can be signed in:

note

NextAuth.js is designed to work with any OAuth service, it supports OAuth 1.0, 1.0A and 2.0 and has built-in support for most popular sign-in services.

OAuth Providers#

Available providers#

How to#

  1. Register your application at the developer portal of your provider. There are links above to the developer docs for most supported providers with details on how to register your application.

  2. The redirect URI should follow this format:

[origin]/api/auth/callback/[provider]

For example, Twitter on localhost this would be:

http://localhost:3000/api/auth/callback/twitter
  1. Create a .env file at the root of your project and add the client ID and client secret. For Twitter this would be:
TWITTER_ID=YOUR_TWITTER_CLIENT_ID
TWITTER_SECRET=YOUR_TWITTER_CLIENT_SECRET
  1. Now you can add the provider settings to the NextAuth options object. You can add as many OAuth providers as you like, as you can see providers is an array.
pages/api/auth/[...nextauth].js
import Providers from `next-auth/providers`
...
providers: [
Providers.Twitter({
clientId: process.env.TWITTER_ID,
clientSecret: process.env.TWITTER_SECRET
})
],
...
  1. Once a provider has been setup, you can sign in at the following URL: [origin]/api/auth/signin. This is an unbranded auto-generated page with all the configured providers.

Options#

NameDescriptionTypeRequired
idUnique ID for the providerstringYes
nameDescriptive name for the providerstringYes
typeType of provider, in this case oauth"oauth"Yes
versionOAuth version (e.g. '1.0', '1.0a', '2.0')stringYes
scopeOAuth access scopes (expects array or string)string or string[]Yes
paramsExtra URL params sent when calling accessTokenUrlObjectYes
accessTokenUrlEndpoint to retrieve an access tokenstringYes
authorizationUrlEndpoint to request authorization from the userstringYes
requestTokenUrlEndpoint to retrieve a request tokenstringYes
profileUrlEndpoint to retrieve the user's profilestringYes
clientIdClient ID of the OAuth providerstringYes
clientSecretClient Secret of the OAuth providerstringYes
profileA callback returning an object with the user's info(profile, tokens) => ObjectYes
protectionAdditional security for OAuth login flows (defaults to state)"pkce","state","none"No
stateSame as protection: "state". Being deprecated, use protection.booleanNo
headersAny headers that should be sent to the OAuth providerObjectNo
authorizationParamsAdditional params to be sent to the authorization endpointObjectNo
idTokenSet to true for services that use ID Tokens (e.g. OpenID)booleanNo
regionOnly when using BattleNetstringNo
domainOnly when using certain ProvidersstringNo
tenantIdOnly when using Azure, Active Directory, B2C, FusionAuthstringNo
tip

Even if you are using a built-in provider, you can override any of these options to tweak the default configuration.

[...nextauth].js
import Providers from "next-auth/providers"
Providers.Auth0({
clientId: process.env.CLIENT_ID,
clientSecret: process.env.CLIENT_SECRET,
domain: process.env.DOMAIN,
scope: "openid your_custom_scope", // We do provide a default, but this will override it if defined
profile(profile) {
return {} // Return the profile in a shape that is different from the built-in one.
},
})

Using a custom provider#

You can use an OAuth provider that isn't built-in by using a custom object.

As an example of what this looks like, this is the provider object returned for the Google provider:

{
id: "google",
name: "Google",
type: "oauth",
version: "2.0",
scope: "https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
params: { grant_type: "authorization_code" },
accessTokenUrl: "https://accounts.google.com/o/oauth2/token",
requestTokenUrl: "https://accounts.google.com/o/oauth2/auth",
authorizationUrl: "https://accounts.google.com/o/oauth2/auth?response_type=code",
profileUrl: "https://www.googleapis.com/oauth2/v1/userinfo?alt=json",
async profile(profile, tokens) {
// You can use the tokens, in case you want to fetch more profile information
// For example several OAuth providers do not return email by default.
// Depending on your provider, will have tokens like `access_token`, `id_token` and or `refresh_token`
return {
id: profile.id,
name: profile.name,
email: profile.email,
image: profile.picture
}
},
clientId: "",
clientSecret: ""
}

Replace all the options in this JSON object with the ones from your custom provider - be sure to give it a unique ID and specify the correct OAuth version - and add it to the providers option when initializing the library:

pages/api/auth/[...nextauth].js
import Providers from `next-auth/providers`
...
providers: [
Providers.Twitter({
clientId: process.env.TWITTER_ID,
clientSecret: process.env.TWITTER_SECRET,
}),
{
id: 'customProvider',
name: 'CustomProvider',
type: 'oauth',
version: '2.0',
scope: '' // Make sure to request the users email address
...
}
]
...

Adding a new provider#

If you think your custom provider might be useful to others, we encourage you to open a PR and add it to the built-in list so others can discover it much more easily!

You only need to add two changes:

  1. Add your config: src/providers/{provider}.js
    • make sure you use a named default export, like this: export default function YourProvider
  2. Add provider documentation: www/docs/providers/{provider}.md
  3. Add it to our provider types (for TS projects)
    • you just need to add your new provider name to this list
    • in case your new provider accepts some custom options, you can add them here

That's it! 🎉 Others will be able to discover this provider much more easily now!

Email Provider#

How to#

The Email provider uses email to send "magic links" that can be used sign in, you will likely have seen them before if you have used software like Slack.

Adding support for signing in via email in addition to one or more OAuth services provides a way for users to sign in if they lose access to their OAuth account (e.g. if it is locked or deleted).

Configuration is similar to other providers, but the options are different:

pages/api/auth/[...nextauth].js
import Providers from `next-auth/providers`
...
providers: [
Providers.Email({
server: process.env.EMAIL_SERVER,
from: process.env.EMAIL_FROM,
// maxAge: 24 * 60 * 60, // How long email links are valid for (default 24h)
}),
],
...

See the Email provider documentation for more information on how to configure email sign in.

note

The email provider requires a database, it cannot be used without one.

Options#

NameDescriptionTypeRequired
idUnique ID for the providerstringYes
nameDescriptive name for the providerstringYes
typeType of provider, in this case email"email"Yes
serverPath or object pointing to the email serverstring or ObjectYes
sendVerificationRequestCallback to execute when a verification request is sent(params) => Promise<undefined>Yes
fromThe email address from which emails are sent, default: "no-reply@example.com"stringNo
maxAgeHow long until the e-mail can be used to log the user in seconds. Defaults to 1 daynumberNo

Credentials Provider#

How to#

The Credentials provider allows you to handle signing in with arbitrary credentials, such as a username and password, two factor authentication or hardware device (e.g. YubiKey U2F / FIDO).

It is intended to support use cases where you have an existing system you need to authenticate users against.

pages/api/auth/[...nextauth].js
import Providers from `next-auth/providers`
...
providers: [
Providers.Credentials({
// The name to display on the sign in form (e.g. 'Sign in with...')
name: 'Credentials',
// The credentials is used to generate a suitable form on the sign in page.
// You can specify whatever fields you are expecting to be submitted.
// e.g. domain, username, password, 2FA token, etc.
credentials: {
username: { label: "Username", type: "text", placeholder: "jsmith" },
password: { label: "Password", type: "password" }
},
async authorize(credentials, req) {
// You need to provide your own logic here that takes the credentials
// submitted and returns either a object representing a user or value
// that is false/null if the credentials are invalid.
// e.g. return { id: 1, name: 'J Smith', email: 'jsmith@example.com' }
// You can also use the `req` object to obtain additional parameters
// (i.e., the request IP address)
const res = await fetch("/your/endpoint", {
method: 'POST',
body: JSON.stringify(credentials),
headers: { "Content-Type": "application/json" }
})
const user = await res.json()
// If no error and we have user data, return it
if (res.ok && user) {
return user
}
// Return null if user data could not be retrieved
return null
}
})
]
...

See the Credentials provider documentation for more information.

note

The Credentials provider can only be used if JSON Web Tokens are enabled for sessions. Users authenticated with the Credentials provider are not persisted in the database.

Options#

NameDescriptionTypeRequired
idUnique ID for the providerstringYes
nameDescriptive name for the providerstringYes
typeType of provider, in this case credentials"credentials"Yes
credentialsThe credentials to sign-in withObjectYes
authorizeCallback to execute once user is to be authorized(credentials, req) => Promise<User>Yes