Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
salesforce

providers/salesforce

Built-in Salesforce integration.

SalesforceProfile

Extends

  • Record<string, any>

Properties

email

email: string;

nickname

nickname: string;

picture

picture: string;

sub

sub: string;

default()

default<P>(options): OAuthConfig<P>

Add Salesforce login to your page.

Setup

Callback URL

https://example.com/api/auth/callback/salesforce

Configuration

import Auth from "@auth/core"
import salesforce from "@auth/core/providers/salesforce"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [salesforce({ clientId: salesforce_CLIENT_ID, clientSecret: salesforce_CLIENT_SECRET })],
})

Resources

Notes

By default, Auth.js assumes that the salesforce provider is based on the OAuth 2 specification.

💡

The Salesforce 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

Type parameter
P extends SalesforceProfile

Parameters

ParameterType
optionsOAuthUserConfig<P>

Returns

OAuthConfig<P>

Auth.js © Balázs Orbán and Team - 2024