Add Zoom sign-in
Users authenticate with Zoom in an Auth.js application.
Auth.js · Const
Zoom
The Zoom provider factory adds Zoom OAuth authentication to Auth.js. Configure it with Zoom client credentials and include the resulting provider in Auth.js's providers array.
How it works
The default export is a provider factory that accepts Zoom OAuth configuration and returns an Auth.js OAuth provider definition. Add the returned provider to the providers array passed to Auth; Auth.js supplies the standard Zoom OAuth settings unless you override them.
Syntax
function default(config): OAuthConfig<ZoomProfile>Parameters
| Name | Type | Description |
|---|---|---|
config | OAuthUserConfig<ZoomProfile> | Optional OAuth provider configuration for the Zoom profile, including credentials and any supported overrides. |
Returns
OAuthConfig<ZoomProfile>
Key points
- The default export is the entry point for adding Zoom sign-in to an Auth.js application.
- Pass the Zoom application's client ID and client secret when constructing the provider.
- Register the documented callback endpoint in the Zoom application's OAuth settings.
- The provider includes built-in settings, so a basic integration does not need every OAuth endpoint specified manually.
Common mistakes
- The provider is configured as OAuth 2 by default; override the built-in settings only when your integration requires it.
Example: Configure Zoom OAuth
import { Auth } from "@auth/core"
import Zoom from "@auth/core/providers/zoom"
const request = new Request(origin)
const response = await Auth(request, {
providers: [
Zoom({
clientId: ZOOM_CLIENT_ID,
clientSecret: ZOOM_CLIENT_SECRET,
}),
],
})Creates an Auth.js request handler configured with Zoom OAuth using the client credentials supplied by the application.
When to use it
Customize provider defaults
An application needs to change a built-in OAuth setting.
Register the OAuth callback
A Zoom OAuth app is being connected to Auth.js Core.
Interview questions
QWhat does the Zoom provider factory accept and return?
Call Zoom with an OAuthUserConfig<ZoomProfile> object, commonly containing clientId and clientSecret. The resulting OAuthConfig<ZoomProfile> belongs in the providers array.
Follow-up: What callback URL must the Zoom application register? Use https://example.com/api/auth/callback/zoom for the documented core setup.
QHow do you configure Zoom login in Auth.js?
Import Zoom from @auth/core/providers/zoom, invoke it with the client credentials, and pass the result to Auth under providers. This enables Zoom login with the provider's defaults.
Follow-up: How can defaults be changed? Supply additional provider options in the factory call, using Auth.js's built-in OAuth-provider customization mechanism.
QWhich callback URL does the Zoom provider document?
The documented callback URL is https://example.com/api/auth/callback/zoom. It is the endpoint Zoom should redirect to after authentication in the shown core configuration.
Follow-up: What happens if the provider configuration needs nonstandard behavior? Override the built-in OAuth defaults in the provider configuration rather than replacing the provider immediately.
Related
ZoomProfileOAuthConfigOAuthUserConfigcustomizing a built-in OAuth provider