npmpackage.info

Gathering detailed insights and metrics for @auth0/auth0-spa-js

Other packages similar to @auth0/auth0-spa-js

@dreamonkey/vue-auth0

1.0.0

@auth0/auth0-spa-js wrapper in the 'Vue way', with full TS support

react-auth0-helper

1.7.3

with @auth0/auth0-spa-js

@auth0/auth0-react

2.2.4

Auth0 SDK for React Single Page Applications (SPA)

auth0

4.14.0

SDK for Auth0 API v2

Gathering detailed insights and metrics for @auth0/auth0-spa-js

@auth0/auth0-spa-js

Auth0 authentication for Single Page Applications (SPA) with PKCE

2.1.3

925

MIT

TypeScript

13.58 kB

119,210,571 5.7

Installations

npm install @auth0/auth0-spa-js

Pull Requests

Open

19

Total

822

Closed

132

Merged

671

Issues

Open

7

Total

497

Closed

490

Releases

v2.1.3

Published on 11 Dec 2023

v2.1.2

Published on 21 Aug 2023

v2.1.1

Published on 19 Jul 2023

v2.1.0

Published on 13 Jul 2023

v2.0.8

Published on 14 Jun 2023

v2.0.7

Published on 02 Jun 2023

View all 79 releases

Developer

auth0

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

18.19.0

NPM Version

10.2.3 Statistics

925 Stars

751 Commits

363 Forks

31 Watching

28 Branches

85 Contributors

Updated on 26 Nov 2024

Bundle Size

44.32 kB

Minified

13.58 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (59.27%)

JavaScript (32.2%)

HTML (8.53%)

Total Downloads

Cumulative downloads

Total Downloads

119,210,571

Last day

-9.7%

143,599

Compared to previous day

Last week

0.6%

805,128

Compared to previous week

Last month

5.5%

3,460,175

Compared to previous month

Last year

22.3%

37,296,958

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Release Downloads CircleCI

📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback

Documentation

Quickstart - our interactive guide for quickly adding login, logout and user information to your app using Auth0.
Sample app - a full-fledged sample app integrated with Auth0.
FAQs - frequently asked questions about auth0-spa-js SDK.
Examples - code samples for common scenarios.
Docs Site - explore our Docs site and learn more about Auth0.

Getting Started

Installation

Using npm in your project directory run the following command:

1npm install @auth0/auth0-spa-js

From the CDN:

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

Configure Auth0

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.

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 RS256 and that "OIDC Conformant" is enabled.

Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:

Allowed Callback URLs: http://localhost:3000
Allowed Logout URLs: http://localhost:3000
Allowed Web Origins: http://localhost:3000

These 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.

Configure the SDK

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

1import { createAuth0Client } from '@auth0/auth0-spa-js';
2
3//with async/await
4const auth0 = await createAuth0Client({
5  domain: '<AUTH0_DOMAIN>',
6  clientId: '<AUTH0_CLIENT_ID>',
7  authorizationParams: {
8    redirect_uri: '<MY_CALLBACK_URL>'
9  }
10});
11
12//or, you can just instantiate the client on its own
13import { Auth0Client } from '@auth0/auth0-spa-js';
14
15const auth0 = new Auth0Client({
16  domain: '<AUTH0_DOMAIN>',
17  clientId: '<AUTH0_CLIENT_ID>',
18  authorizationParams: {
19    redirect_uri: '<MY_CALLBACK_URL>'
20  }
21});
22
23//if you do this, you'll need to check the session yourself
24try {
25  await auth0.getTokenSilently();
26} catch (error) {
27  if (error.error !== 'login_required') {
28    throw error;
29  }
30}

Logging In

You can then use login using the Auth0Client instance you created:

1<button id="login">Click to Login</button>

1//redirect to the Universal Login Page
2document.getElementById('login').addEventListener('click', async () => {
3  await auth0.loginWithRedirect();
4});
5
6//in your callback route (<MY_CALLBACK_URL>)
7window.addEventListener('load', async () => {
8  const redirectResult = await auth0.handleRedirectCallback();
9  //logged in. you can get the user profile like this:
10  const user = await auth0.getUser();
11  console.log(user);
12});

For other comprehensive examples, see the EXAMPLES.md document.

API Reference

Explore API Methods available in auth0-spa-js.

Feedback

Contributing

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

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

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 Logo

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.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

SAST

Determines if the project uses static code analysis.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

6

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

5

Maintained

Determines if the project is "actively maintained".

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/browserstack.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/browserstack.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-release.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/npm-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rl-secure.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/rl-secure.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/semgrep.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/semgrep.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snyk.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/snyk.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:135: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:157: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-spa-js/test.yml/main?enable=pin
Info: 0 out of 18 GitHub-owned GitHubAction dependencies pinned
Info: 2 out of 2 third-party GitHubAction dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @auth0/auth0-spa-js

Other packages similar to @auth0/auth0-spa-js

@auth0/auth0-spa-js

Installations

Pull Requests

19

822

132

671

Issues

7

497

490

Releases

Developer

auth0

Developer Guide

CommonJS

Yes

18.19.0

10.2.3

Statistics

Bundle Size

44.32 kB

13.58 kB

Languages

Total Downloads

119,210,571

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

Documentation

Getting Started

Installation

Configure Auth0

Configure the SDK

Logging In

API Reference

Feedback

Contributing

Raise an issue

Vulnerability Reporting

What is Auth0?

10

10

10

10

10

8

6

5

3

0

0

0

0

5.7

/10