Skip to main content

providers/credentials

default()​

default<CredentialsInputs>(config): CredentialsConfig

The Credentials provider allows you to handle signing in with arbitrary credentials, such as a username and password, domain, or 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.

It comes with the constraint that users authenticated in this manner are not persisted in the database, and consequently that the Credentials provider can only be used if JSON Web Tokens are enabled for sessions.

NOTE

The functionality provided for credentials based authentication is intentionally limited to discourage use of passwords due to the inherent security risks associated with them and the additional complexity associated with supporting usernames and passwords.

See the callbacks documentation for more information on how to interact with the token. For example, you can add additional information to the token by returning an object from the jwt() callback:

callbacks: {
  async jwt(token, user, account, profile, isNewUser) {
    if (user) {
      token.id = user.id
    }
    return token
  }
}

Example​

import Auth from "@auth/core"
import Credentials from "@auth/core/providers/credentials"

const request = new Request("https://example.com")
const response = await AuthHandler(request, {
  providers: [
    Credentials({
      credentials: {
        username: { label: "Username" },
        password: { label: "Password", type: "password" }
      },
      async authorize({ request }) {
        const response = await fetch(request)
        if (!response.ok) return null
        return (await response.json()) ?? null
      }
    })
  ],
  secret: "...",
  trustHost: true
})

See​

Type parameters​

ParameterDefault
CredentialsInputs extends Record< string, CredentialInput >Record< string, CredentialInput >

Parameters​

ParameterType
configPartial< CredentialsConfig< CredentialsInputs > >

Returns​

CredentialsConfig

CredentialInput​

Besides providing type safety inside authorize it also determines how the credentials input fields will be rendered on the default sign in page.

CredentialsConfig​

The Credentials Provider needs to be configured.

Type parameters​

ParameterDefault
CredentialsInputs extends Record< string, CredentialInput >Record< string, CredentialInput >

Properties​

authorize​

authorize: (credentials, request) => Awaitable< null | User >

Gives full control over how you handle the credentials received from the user.

danger

There is no validation on the user inputs by default, so make sure you do so by a popular library like Zod

Example​
//...
async authorize(credentials, request) {
  if(!isValidCredentials(credentials)) return null
  const response = await fetch(request)
  if(!response.ok) return null
  return await response.json() ?? null
}
//...
Parameters​
ParameterTypeDescription
credentialsPartial< Record< keyof CredentialsInputs, unknown > >The available keys are determined by CredentialInput.

Note

The existence/correctness of a field cannot be guaranteed at compile time,
so you should always validate the input before using it.

You can add basic validation depending on your use case,
or you can use a popular library like Zod for example.
requestRequestThe original request is forward for convenience
Returns​

Awaitable< null | User >

id​

id: string

Uniquely identifies the provider in AuthConfig.providers It's also part of the URL

Inherited from​

CommonProviderOptions.id

name​

name: string

The provider name used on the default sign-in page's sign-in button. For example if it's "Google", the corresponding button will say: "Sign in with Google"

Inherited from​

CommonProviderOptions.name