npmpackage.info

@auth0/auth0-react

Auth0 SDK for React Single Page Applications (SPA)

2.2.4

892

MIT

TypeScript

70,533,542 5.6

Installations

npm install @auth0/auth0-react

Pull Requests

Open

15

Total

472

Closed

88

Merged

369

Issues

Open

15

Total

338

Closed

323

Releases

v2.2.4

Published on 11 Dec 2023

v2.2.3

Published on 02 Nov 2023

v2.2.2

Published on 31 Oct 2023

v2.2.1

Published on 22 Aug 2023

v2.2.0

Published on 13 Jul 2023

v2.1.1

Published on 14 Jun 2023

View all 32 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

892 Stars

494 Commits

264 Forks

25 Watching

23 Branches

59 Contributors

Updated on 27 Nov 2024

Languages

TypeScript (87.79%)

JavaScript (7.01%)

HTML (5.12%)

Shell (0.09%)

Total Downloads

Cumulative downloads

Total Downloads

70,533,542

Last day

-10.6%

82,296

Compared to previous day

Last week

-0.2%

458,020

Compared to previous week

Last month

1,983,039

Compared to previous month

Last year

22.4%

22,148,094

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Downloads

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

Documentation

Quickstart - our interactive guide for quickly adding login, logout and user information to a React app using Auth0.
Sample App - a full-fledged React application integrated with Auth0.
FAQs - frequently asked questions about the auth0-react SDK.
Examples - code samples for common React authentication scenario's.
Docs site - explore our docs site and learn more about Auth0.

Getting started

Installation

Using npm

1npm install @auth0/auth0-react

Using yarn

1yarn add @auth0/auth0-react

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.

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

Configure the SDK by wrapping your application in Auth0Provider:

1// src/index.js
2import React from 'react';
3import { createRoot } from 'react-dom/client';
4import { Auth0Provider } from '@auth0/auth0-react';
5import App from './App';
6
7const root = createRoot(document.getElementById('app'));
8
9root.render(
10  <Auth0Provider
11    domain="YOUR_AUTH0_DOMAIN"
12    clientId="YOUR_AUTH0_CLIENT_ID"
13    authorizationParams={{
14      redirect_uri: window.location.origin,
15    }}
16  >
17    <App />
18  </Auth0Provider>
19);

Instructions for React <18

1// src/index.js
2import React from 'react';
3import ReactDOM from 'react-dom';
4import { Auth0Provider } from '@auth0/auth0-react';
5import App from './App';
6
7ReactDOM.render(
8  <Auth0Provider
9    domain="YOUR_AUTH0_DOMAIN"
10    clientId="YOUR_AUTH0_CLIENT_ID"
11    authorizationParams={{
12      redirect_uri: window.location.origin,
13    }}
14  >
15    <App />
16  </Auth0Provider>,
17  document.getElementById('app')
18);

Use the useAuth0 hook in your components to access authentication state (isLoading, isAuthenticated and user) and authentication methods (loginWithRedirect and logout):

1// src/App.js
2import React from 'react';
3import { useAuth0 } from '@auth0/auth0-react';
4
5function App() {
6  const { isLoading, isAuthenticated, error, user, loginWithRedirect, logout } =
7    useAuth0();
8
9  if (isLoading) {
10    return <div>Loading...</div>;
11  }
12  if (error) {
13    return <div>Oops... {error.message}</div>;
14  }
15
16  if (isAuthenticated) {
17    return (
18      <div>
19        Hello {user.name}{' '}
20        <button onClick={() => logout({ logoutParams: { returnTo: window.location.origin } })}>
21          Log out
22        </button>
23      </div>
24    );
25  } else {
26    return <button onClick={() => loginWithRedirect()}>Log in</button>;
27  }
28}
29
30export default App;

For more code samples on how to integrate auth0-react SDK in your React application, have a look at our examples.

API reference

Explore public API's available in auth0-react.

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.

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

Code-Review

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

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.

4

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 4

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-react/browserstack.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/browserstack.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/browserstack.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/integration.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-react/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-react/rl-secure.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/semgrep.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/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-react/snyk.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/auth0/auth0-react/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-react/test.yml/main?enable=pin
Info: 0 out of 16 GitHub-owned GitHubAction dependencies pinned
Info: 2 out of 2 third-party GitHubAction dependencies pinned
Info: 1 out of 1 npmCommand dependencies pinned

1

Maintained

Determines if the project is "actively maintained".

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

/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

@auth0/auth0-react

Installations

Pull Requests

15

472

88

369

Issues

15

338

323

Releases

Developer

auth0

Developer Guide

CommonJS

Yes

18.19.0

10.2.3

Statistics

Languages

Total Downloads

70,533,542

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Documentation

Getting started

Installation

Configure Auth0

Configure the SDK

API reference

Feedback

Contributing

Raise an issue

Vulnerability Reporting

10

10

10

10

10

10

4

1

0

0

0

0

5.6

/10