providers

Provider

Provider: <P> OIDCConfig<P> | OAuth2Config<P> | EmailConfig | CredentialsConfig & InternalProviderOptions | (...args: any) => OAuth2Config<P> | OIDCConfig<P> | EmailConfig | CredentialsConfig & InternalProviderOptions & InternalProviderOptions

Must be a supported authentication provider config:

• OAuthConfig
• EmailConfigInternal
• CredentialsConfigInternal

For more information, see the guides:

See

• OAuth/OIDC guide
• Email (Passwordless) guide
• Credentials guide

Type parameters

• P extends Profile = any

---

ProviderType

ProviderType: "oidc" | "oauth" | "email" | "credentials"

Providers passed to Auth.js must define one of these types.

See

• RFC 6749 - The OAuth 2.0 Authorization Framework
• OpenID Connect Core 1.0
• Email or Passwordless Authentication
• Credentials-based Authentication

---

CommonProviderOptions

Shared across all ProviderType

Properties

id

id: string

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

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"

type

type: ProviderType

See ProviderType

---