Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(providers): add webex oauth #9653

Merged
merged 9 commits into from
Feb 10, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/2_bug_provider.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ body:
- "Twitch"
- "Twitter"
- "Vk"
- "Webex"
- "Wordpress"
- "WorkOS"
- "Yandex"
Expand Down
19 changes: 19 additions & 0 deletions docs/static/img/providers/webex.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
99 changes: 99 additions & 0 deletions packages/core/src/providers/webex.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/**
* <div style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
* <span>Built-in <b>Webex</b> integration.</span>
* <a href="https://webex.com">
* <img style={{display: "block"}} src="https://authjs.dev/img/providers/webex.svg" height="48" width="48"/>
* </a>
* </div>
*
* @module providers/webex
*/
import type { OAuthConfig, OAuthUserConfig } from "./index.js"

/**
* The returned user profile from Webex when using the profile callback.
*
* Please refer to {@link https://developer.webex.com/docs/api/v1/people/get-my-own-details|People - Get My Own Details}
* on Webex Developer portal for additional fields.
*/
export interface WebexProfile extends Record<string, any> {
id: string;
emails: [string, ...string[]];
askmrsinh marked this conversation as resolved.
Show resolved Hide resolved
displayName?: string;
avatar?: string;
}

/**
* Add Webex login to your page.
*
* ### Setup
*
* #### Callback URL
* ```
* https://example.com/api/auth/callback/webex
* ```
*
* #### Configuration
*```js
* 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
*
* - [Webex OAuth 2.0 Integration Guide](https://developer.webex.com/docs/integrations)
* - [Login with Webex](https://developer.webex.com/docs/login-with-webex)
*
* ### Notes
*
* By default, Auth.js assumes that the Webex provider is
* based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
*
* :::tip
*
* The Webex provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/webex.ts).
* To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/providers/custom-provider#override-default-options).
*
* :::
*
* :::info **Disclaimer**
*
* If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-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](https://authjs.dev/new/github-discussions).
*
* :::
*/
export default function Webex<P extends WebexProfile>(
config: OAuthUserConfig<P>
ndom91 marked this conversation as resolved.
Show resolved Hide resolved
): OAuthConfig<P> {
const apiBaseUrl = config?.apiBaseUrl ?? 'https://webexapis.com/v1';
askmrsinh marked this conversation as resolved.
Show resolved Hide resolved

return {
id: 'webex',
name: 'Webex',
type: 'oauth',
authorization: {
url: apiBaseUrl + '/authorize',
params: { scope: 'spark:kms spark:people_read' }
},
token: apiBaseUrl + '/access_token',
userinfo: apiBaseUrl + '/people/me',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny nit on these, can you change them to string interpolation? i.e. ${apiBaseUrl}/people/me? 🙏

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

profile(profile) {
return {
id: profile.id,
email: profile.emails[0],
name: profile.displayName,
image: profile.avatar
}
},
options: config
};
}