Skip to content

rightmoveapp/react-Auth0example

Repository files navigation

Auth0 React Authorization

This sample demonstrates how to include user authorization in a React application with Auth0.

Getting Started

If you haven't already done so, sign up for your free Auth0 account and create a new client in the dashboard. Find the domain and client ID from the settings area and add the URL for your application to the Allowed Callback URLs box. The default URL is http://localhost:3000/callback. Also configure Allowed Web Origins to the default application URL http://localhost:3000.

Clone the repo or download it from the React quickstart page in Auth0's documentation.

Open the demo.

cd 04-Authorization

Install the dependencies for the app.

npm install

Set up a new API

More complete documentation is available at React Calling an API.

From the Auth0 dashboard, select the APIs section and select "Create API":

  • Add a name for the API. A friendly name for the API.
  • Select an identifier for the endpoint. A logical identifier for this API. We recommend using a URL but note that this doesn’t have to be a publicly available URL, Auth0 will not call your API at all. Important! This field cannot be modified.

For purposes of this demo, you may want to consider using http://localhost:3001 as your identifier.

You will also need to add in a new scope. Scopes allow you to define the data that will be accessed through the applications to your API. Set a name for them and its description for better understanding.

  • Select the Scopes tab from the API section.
  • In the name textbox, enter in read:messages.
  • Add a description for this scope ex: permission to read messages and click the 'add' button.

Set the Client ID, Domain, and API identifier

If you download the sample from the quickstart page, it will come pre-populated with the client ID and domain for your application. If you clone the repo directly from Github, rename the auth0-variables.js.example file to auth0-variables.js and provide the client ID and domain there. This file is located in src/Auth/.

You should also provide the identifier for the API you create in the Auth0 dashboard as your apiUrl.

Set Up the .env File

In addition to the above-mentioned auth0-variables.js file, a .env file is provided at the root of the application. This file provides your application's credentials to the small Node server located in server.js.

This file has two values, AUTH0_AUDIENCE and AUTH0_DOMAIN. If you download this sample from the quickstart page, the value for AUTH0_DOMAIN will be populated automatically, but you will still need to populate AUTH0_AUDIENCE manually. The value for AUTH0_AUDIENCE is the identifier used for an API that you create in the Auth0 dashboard.

Run the Application

The demo comes ready to serve locally using react-scripts.

npm start

The application will be served at http://localhost:3000.

Run the Application With Docker

In order to run the example with docker you need to have docker installed.

You also need to set the environment variables as explained previously.

Execute in command line sh exec.sh to run the Docker in Linux, or .\exec.ps1 to run the Docker in Windows.

What is Auth0?

Auth0 helps you to:

  • Add authentication with multiple authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, among others, or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider.
  • Add authentication through more traditional username/password databases.
  • Add support for linking different user accounts with the same user.
  • Support for generating signed Json Web Tokens to call your APIs and flow the user identity securely.
  • Analytics of how, when and where users are logging in.
  • Pull data from other sources and add it to the user profile, through JavaScript rules.

Create a Free Auth0 Account

  1. Go to Auth0 and click Sign Up.
  2. Use Google, GitHub or Microsoft Account to login.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published