Skip to content
Auth0 authentication for Single Page Applications (SPA) with PKCE
TypeScript JavaScript HTML
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Initial Commit Apr 10, 2019
.github Setup the CODEOWNERS for pull request reviews May 6, 2019
.vscode Initial Commit Apr 10, 2019
__tests__ Add popup timeout config (#133) Aug 7, 2019
cypress Initial Commit Apr 10, 2019
docs Release 1.1.1 (#100) Jul 22, 2019
scripts Upgrading all packages (#91) Jul 18, 2019
src Fix popup timeout (#152) Aug 14, 2019
static Add popup timeout config (#133) Aug 7, 2019
.eslintrc.security Add security linters May 6, 2019
.gitignore Initial Commit Apr 10, 2019
.npmignore Initial Commit Apr 10, 2019
.prettierignore Initial Commit Apr 10, 2019
.prettierrc Initial Commit Apr 10, 2019
CHANGELOG.md Release 1.1.1 (#100) Jul 22, 2019
CONTRIBUTING.md Initial Commit Apr 10, 2019
FAQ.md Add `default is not a function` entry to our FAQ (#130) Aug 7, 2019
Jenkinsfile only publish on master Apr 10, 2019
LICENSE Initial Commit Apr 10, 2019
README.md Link to documentation and migration guide (#128) Aug 1, 2019
cypress.json Initial Commit Apr 10, 2019
jest.config.js Initial Commit Apr 10, 2019
package-lock.json [Security] Bump lodash from 4.17.11 to 4.17.15 (#148) Aug 13, 2019
package.json Bump typedoc from 0.14.2 to 0.15.0 (#119) Jul 29, 2019
rollup.config.js Make sure our production bundle is ES5 compatible. (#98) Jul 22, 2019
security-tslint.json Add security linters May 6, 2019
tsconfig.json Initial Commit Apr 10, 2019
typedoc.js Initial Commit Apr 10, 2019

README.md

@auth0/auth0-spa-js

Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE.

CircleCI License

Table of Contents

Documentation

Installation

From the CDN:

<script src="https://cdn.auth0.com/js/auth0-spa-js/1.1.1/auth0-spa-js.production.js"></script>

Using npm:

npm install @auth0/auth0-spa-js

Using yarn:

yarn add @auth0/auth0-spa-js

Getting Started

Creating the client

Create an Auth0Client instance before rendering or initializing your application. You should only have one instance of the client.

//with async/await
const auth0 = await createAuth0Client({
  domain: '<AUTH0_DOMAIN>',
  client_id: '<AUTH0_CLIENT_ID>',
  redirect_uri: '<MY_CALLBACK_URL>'
});

//with promises
createAuth0Client({
  domain: '<AUTH0_DOMAIN>',
  client_id: '<AUTH0_CLIENT_ID>',
  redirect_uri: '<MY_CALLBACK_URL>'
}).then(auth0 => {
  //...
});

1 - Login

<button id="login">Click to Login</button>
//with async/await

//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);
});

//with promises

//redirect to the Universal Login Page
document.getElementById('login').addEventListener('click', () => {
  auth0.loginWithRedirect().catch(() => {
    //error while redirecting the user
  });
});

//in your callback route (<MY_CALLBACK_URL>)
window.addEventListener('load', () => {
  auth0.handleRedirectCallback().then(redirectResult => {
    //logged in. you can get the user profile like this:
    auth0.getUser().then(user => {
      console.log(user);
    });
  });
});

2 - Calling an API

<button id="call-api">Call an API</button>
//with async/await
document.getElementById('call-api').addEventListener('click', async () => {
  const accessToken = await auth0.getTokenSilently();
  const result = await fetch('https://myapi.com', {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${accessToken}`
    }
  });
  const data = await result.json();
  console.log(data);
});

//with promises
document.getElementById('call-api').addEventListener('click', () => {
  auth0
    .getTokenSilently()
    .then(accessToken =>
      fetch('https://myapi.com', {
        method: 'GET',
        headers: {
          Authorization: `Bearer ${accessToken}`
        }
      })
    )
    .then(result => result.json())
    .then(data => {
      console.log(data);
    });
});

3 - Logout

<button id="logout">Logout</button>
import createAuth0Client from '@auth0/auth0-spa-js';

document.getElementById('logout').addEventListener('click', () => {
  auth0.logout();
});

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

Support + Feedback

This SDK is in Early Access with selected stakeholders.

We process feedback and provide support via private channels.

Frequently Asked Questions

For a rundown of common issues you might encounter when using the SDK, please check out the FAQ.

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

What is Auth0?

Auth0 helps you to easily:

  • implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.)
  • log in users with username/password databases, passwordless, or multi-factor authentication
  • link multiple user accounts together
  • generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely
  • access demographics and analytics detailing how, when, and where users are logging in
  • enrich user profiles from other data sources using customizable JavaScript rules

Why Auth0?

License

This project is licensed under the MIT license. See the LICENSE file for more info.

You can’t perform that action at this time.