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

providers/webex

Built-in Webex integration.

WebexProfile

The returned user profile from Webex when using the profile callback.

Please refer to People - Get My Own Details on Webex Developer portal for additional fields. Returned fields may vary depending on the user’s role, the OAuth integration’s scope, and the organization the OAuth integration belongs to.

Extends

  • Record<string, any>

Properties

avatar?

optional avatar: string;

displayName?

optional displayName: string;

emails

emails: string[];

id

id: string;

default()

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

Add Webex login to your page.

Setup

Callback URL

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

Configuration

import Auth from "@auth/core"
import Webex from "@auth/core/providers/webex"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [Webex({ clientId: WEBEX_CLIENT_ID, clientSecret: WEBEX_CLIENT_SECRET })],
})

Resources

Notes

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

💡

The Webex 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 WebexProfile

Parameters

ParameterType
configOAuthUserConfig<P> & { apiBaseUrl: string; }

Returns

OAuthConfig<P>

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