@auth0/auth0-spa-js
Advanced tools
Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE
@auth0/auth0-spa-js is a JavaScript library designed to handle authentication in single-page applications (SPAs) using Auth0. It provides a simple and secure way to integrate Auth0's authentication and authorization services into your SPA.
Login
This feature allows users to log in to your application using Auth0. The code sample demonstrates how to create an Auth0 client and initiate a login redirect.
const auth0 = await createAuth0Client({
domain: 'YOUR_DOMAIN',
client_id: 'YOUR_CLIENT_ID'
});
await auth0.loginWithRedirect({
redirect_uri: window.location.origin
});Logout
This feature allows users to log out of your application. The code sample shows how to log out and redirect the user to the home page.
await auth0.logout({
returnTo: window.location.origin
});Get User Information
This feature retrieves the authenticated user's information. The code sample demonstrates how to get the user profile after authentication.
const user = await auth0.getUser();
console.log(user);Token Handling
This feature handles token retrieval for authenticated requests. The code sample shows how to get an access token silently without redirecting the user.
const token = await auth0.getTokenSilently();
console.log(token);oidc-client is a JavaScript library for OpenID Connect (OIDC) and OAuth2. It provides similar functionalities for handling authentication and authorization in SPAs. Compared to @auth0/auth0-spa-js, oidc-client is more generic and can be used with any OIDC-compliant identity provider.
Firebase Authentication provides backend services to help authenticate users in your application. It supports various authentication methods, including email/password, phone, and social providers. Unlike @auth0/auth0-spa-js, Firebase offers a broader range of services beyond authentication, such as database and hosting.
📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback
Using npm in your project directory run the following command:
npm install @auth0/auth0-spa-js
From the CDN:
<script src="https://cdn.auth0.com/js/auth0-spa-js/2.1/auth0-spa-js.production.js"></script>
Create a Single Page Application in the Auth0 Dashboard.
If you're using an existing application, verify that you have configured the following settings in your Single Page Application:
- Click on the "Settings" tab of your application's page.
- Ensure that "Token Endpoint Authentication Method" under "Application Properties" is set to "None"
- Scroll down and click on the "Show Advanced Settings" link.
- Under "Advanced Settings", click on the "OAuth" tab.
- Ensure that "JsonWebToken Signature Algorithm" is set to
RS256and that "OIDC Conformant" is enabled.
Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:
http://localhost:3000http://localhost:3000http://localhost:3000These URLs should reflect the origins that your application is running on. Allowed Callback URLs may also include a path, depending on where you're handling the callback (see below).
Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.
Create an Auth0Client instance before rendering or initializing your application. You should only have one instance of the client.
import { createAuth0Client } from '@auth0/auth0-spa-js';
//with async/await
const auth0 = await createAuth0Client({
domain: '<AUTH0_DOMAIN>',
clientId: '<AUTH0_CLIENT_ID>',
authorizationParams: {
redirect_uri: '<MY_CALLBACK_URL>'
}
});
//or, you can just instantiate the client on it's own
import { Auth0Client } from '@auth0/auth0-spa-js';
const auth0 = new Auth0Client({
domain: '<AUTH0_DOMAIN>',
clientId: '<AUTH0_CLIENT_ID>',
authorizationParams: {
redirect_uri: '<MY_CALLBACK_URL>'
}
});
//if you do this, you'll need to check the session yourself
try {
await auth0.getTokenSilently();
} catch (error) {
if (error.error !== 'login_required') {
throw error;
}
}
You can then use login using the Auth0Client instance you created:
<button id="login">Click to Login</button>
//redirect to the Universal Login Page
document.getElementById('login').addEventListener('click', async () => {
await auth0.loginWithRedirect();
});
//in your callback route (<MY_CALLBACK_URL>)
window.addEventListener('load', async () => {
const redirectResult = await auth0.handleRedirectCallback();
//logged in. you can get the user profile like this:
const user = await auth0.getUser();
console.log(user);
});
For other comprehensive examples, see the EXAMPLES.md document.
Explore API Methods available in auth0-spa-js.
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
To provide feedback or report a bug, please raise an issue on our issue tracker.
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.
v2.1.0 (2023-07-13)
Added
Fixed
FAQs
Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE
The npm package @auth0/auth0-spa-js receives a total of 745,687 weekly downloads. As such, @auth0/auth0-spa-js popularity was classified as popular.
We found that @auth0/auth0-spa-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 45 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.