providers

callbackUrl: string;

id: string;

name: string;

signinUrl: string;

type: ProviderType;

id: string;

name: string;

type: ProviderType;

optional [conformInternal]: true;

optional [customFetch]: (input, init?) => Promise<Response>;

optional account: AccountCallback;

import GitHub from "@auth/core/providers/github"
// ...
GitHub({
  account(account) {
    // https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token
    const refresh_token_expires_at =
      Math.floor(Date.now() / 1000) + Number(account.refresh_token_expires_in)
    return {
      access_token: account.access_token,
      expires_at: account.expires_at,
      refresh_token: account.refresh_token,
      refresh_token_expires_at
    }
  }
})

optional allowDangerousEmailAccountLinking: boolean;

optional authorization: string | AuthorizationEndpointHandler;

optional checks: ("none" | "state" | "pkce")[];

["pkce"]

optional client: Partial<Client & {
  token_endpoint_auth_method: string;
}>;

optional clientId: string;

optional clientSecret: string;

id: string;

signIn('github') // "github" is the provider ID

optional issuer: string;

jwks_endpoint: any;

name: string;

optional options: OAuthUserConfig<Profile>;

optional profile: ProfileCallback<Profile>;

optional redirectProxyUrl: string;

optional style: OAuthProviderButtonStyles;

optional token: string | TokenEndpointHandler;

type: "oauth";

optional userinfo: string | UserinfoEndpointHandler;

optional wellKnown: string;

optional bg: string;

optional brandColor: string;

optional logo: string;

optional text: string;

optional [conformInternal]: true;

optional [customFetch]: (input, init?) => Promise<Response>;

optional account: AccountCallback;

import GitHub from "@auth/core/providers/github"
// ...
GitHub({
  account(account) {
    // https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token
    const refresh_token_expires_at =
      Math.floor(Date.now() / 1000) + Number(account.refresh_token_expires_in)
    return {
      access_token: account.access_token,
      expires_at: account.expires_at,
      refresh_token: account.refresh_token,
      refresh_token_expires_at
    }
  }
})

optional allowDangerousEmailAccountLinking: boolean;

optional authorization: string | AuthorizationEndpointHandler;

optional checks: ("none" | "state" | "nonce" | "pkce")[];

optional client: Partial<Client & {
  token_endpoint_auth_method: string;
}>;

optional clientId: string;

optional clientSecret: string;

id: string;

signIn('github') // "github" is the provider ID

optional idToken: boolean;

optional issuer: string;

jwks_endpoint: any;

name: string;

optional options: OAuthUserConfig<Profile>;

optional profile: ProfileCallback<Profile>;

optional redirectProxyUrl: string;

optional style: OAuthProviderButtonStyles;

optional token: string | TokenEndpointHandler;

type: "oidc";

optional userinfo: string | UserinfoEndpointHandler;

optional wellKnown: string;

type AccountCallback: (tokens) => TokenSet | undefined | void;

type AppProviders: (Provider | ReturnType<BuiltInProviders[keyof BuiltInProviders]>)[];

type AuthorizationEndpointHandler: EndpointHandler<AuthorizationParameters>;

type BuiltInProviderType: RedirectableProviderType | OAuthProviderType | WebAuthnProviderType;

type BuiltInProviders: Record<OAuthProviderType, (config) => OAuthConfig<any>> & Record<CredentialsProviderType, typeof default> & Record<EmailProviderType, typeof default> & Record<WebAuthnProviderType, (config) => WebAuthnConfig>;

type OAuthChecks: OpenIDCallbackChecks | OAuthCallbackChecks;

type OAuthConfig<Profile>: OIDCConfig<Profile> | OAuth2Config<Profile>;

type OAuthEndpointType: "authorization" | "token" | "userinfo";

type OAuthProviderType: 
  | "42-school"
  | "apple"
  | "asgardeo"
  | "atlassian"
  | "auth0"
  | "authentik"
  | "azure-ad-b2c"
  | "azure-ad"
  | "azure-devops"
  | "bankid-no"
  | "battlenet"
  | "beyondidentity"
  | "box"
  | "boxyhq-saml"
  | "bungie"
  | "click-up"
  | "cognito"
  | "coinbase"
  | "concept2"
  | "descope"
  | "discord"
  | "dribbble"
  | "dropbox"
  | "duende-identity-server6"
  | "eventbrite"
  | "eveonline"
  | "facebook"
  | "faceit"
  | "forwardemail"
  | "foursquare"
  | "freshbooks"
  | "fusionauth"
  | "github"
  | "gitlab"
  | "google"
  | "hubspot"
  | "identity-server4"
  | "instagram"
  | "kakao"
  | "keycloak"
  | "kinde"
  | "line"
  | "linkedin"
  | "mailchimp"
  | "mailgun"
  | "mailru"
  | "mastodon"
  | "mattermost"
  | "medium"
  | "microsoft-entra-id"
  | "naver"
  | "netlify"
  | "netsuite"
  | "nextcloud"
  | "nodemailer"
  | "notion"
  | "okta"
  | "onelogin"
  | "ory-hydra"
  | "osso"
  | "osu"
  | "passage"
  | "passkey"
  | "patreon"
  | "ping-id"
  | "pinterest"
  | "pipedrive"
  | "postmark"
  | "reddit"
  | "resend"
  | "roblox"
  | "salesforce"
  | "sendgrid"
  | "simplelogin"
  | "slack"
  | "spotify"
  | "strava"
  | "threads"
  | "tiktok"
  | "todoist"
  | "trakt"
  | "twitch"
  | "twitter"
  | "united-effects"
  | "vipps"
  | "vk"
  | "webauthn"
  | "webex"
  | "wechat"
  | "wikimedia"
  | "wordpress"
  | "workos"
  | "yandex"
  | "zitadel"
  | "zoho"
  | "zoom";

type OAuthUserConfig<Profile>: Omit<Partial<OAuthConfig<Profile>>, "options" | "type">;

type OIDCConfigInternal<Profile>: OAuthConfigInternal<Profile> & {
  checks: OIDCConfig<Profile>["checks"];
  idToken: OIDCConfig<Profile>["idToken"];
};

checks: OIDCConfig<Profile>["checks"];

idToken: OIDCConfig<Profile>["idToken"];

type OIDCUserConfig<Profile>: Omit<Partial<OIDCConfig<Profile>>, "options" | "type">;

type ProfileCallback<Profile>: (profile, tokens) => Awaitable<User>;

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

type ProviderType: 
  | "oidc"
  | "oauth"
  | "email"
  | "credentials"
  | WebAuthnProviderType;

type RedirectableProviderType: "email" | "credentials";

type TokenEndpointHandler: EndpointHandler<UrlParams, {
  checks: OAuthChecks;
  params: CallbackParamsType;
  }, {
  tokens: TokenSet;
}>;

type UserinfoEndpointHandler: EndpointHandler<UrlParams, {
  tokens: TokenSet;
}, Profile>;