📚 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);

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.

• Auth0Provider
• Auth0ProviderOptions
• useAuth0
• withAuth0
• withAuthenticationRequired

Feedback

Contributing

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

• Auth0's general contribution guidelines
• Auth0's code of conduct guidelines
• This repo's contribution guide

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