@magic-ext/oauth
v23.0.6
Published
Magic SDK OAuth Extension for Web environments.
Downloads
38,929
Maintainers
seanli
damianjachyra
ethella
hcote
mikeysight
jasonatmagic
magiclabs_fe
jonathansoper
darrentmagic
khaledali.magic
ritalestermagic
dizigen
jmac-magic
noahyoshida
jfifer-b9s
alexandermann
zilanouyangKeywords
Readme
🔒 Magic OAuth Extension for Web Browsers
We suggest use OAUTH2
@magic-ext/oauth2package for the best performance
With the Magic JavaScript SDK OAuth extension, you can plug into your favorite social login providers with one, easy-to-use API.
📖 Documentation
See the developer documentation to learn how to get started with OAuth in Magic SDK.
🔗 Installation
Integrating your app with OAuth will require our client-side NPM package and OAuth extension:
# Via NPM:
npm install --save magic-sdk @magic-ext/oauth
# Via Yarn:
yarn add magic-sdk @magic-ext/oauthAlternatively, you can load via CDN with by adding a script tag to your app’s <head>:
<script src="https://cdn.jsdelivr.net/npm/magic-sdk/dist/magic.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@magic-ext/oauth/dist/extension.js"></script>⚡️ Quick Start
Sign up or log in to the developer dashboard to receive API keys that will allow your application to interact with Magic's authentication APIs.
Then, you can start authenticating users with just two method calls!
From your login page:
import { Magic } from 'magic-sdk';
import { OAuthExtension } from '@magic-ext/oauth';
const magic = new Magic('YOUR_API_KEY', {
extensions: [new OAuthExtension()]
});
await magic.oauth.loginWithRedirect({
provider: 'google' | 'facebook' | 'github' | ...
});From your OAuth callback page:
import { Magic } from 'magic-sdk';
import { OAuthExtension } from '@magic-ext/oauth';
const magic = new Magic('YOUR_API_KEY', {
extensions: [new OAuthExtension()]
});
const res = await magic.oauth.getRedirectResult();
// Then you can access a user's Magic DID token, OAuth access token,
// OpenID Connect profile information, and more!
res.magic.idToken;
res.oauth.accessToken;
res.oauth.userInfo;