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

providers/zoom

Built-in Zoom integration.

ZoomProfile

See: https://developers.zoom.us/docs/integrations/oauth/#using-an-access-token

Extends

  • Record<string, any>

Properties

account_id

account_id: string;

created_at

created_at: string;

dept

dept: string;

email

email: string;

first_name

first_name: string;

group_ids

group_ids: string[];

host_key

host_key: string;

id

id: string;

im_group_ids

im_group_ids: string[];

jid

jid: string;

language

language: string;

last_client_version

last_client_version: string;

last_login_time

last_login_time: string;

last_name

last_name: string;

personal_meeting_url

personal_meeting_url: string;

phone_country

phone_country: string;

phone_number

phone_number: string;

pic_url

pic_url: string;

pmi

pmi: number;

role_name

role_name: string;

status

status: string;

timezone

timezone: string;

type

type: number;

use_pmi

use_pmi: boolean;

vanity_url

vanity_url: string;

verified

verified: number;

default()

default(config): OAuthConfig<ZoomProfile>

Add Zoom login to your page.

Setup

Callback URL

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

Configuration

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 }),
  ],
})

Resources

Notes

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

💡

The Zoom 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.

Parameters

ParameterType
configOAuthUserConfig<ZoomProfile>

Returns

OAuthConfig<ZoomProfile>

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