auth0

What is auth0?

The auth0 npm package provides a comprehensive solution for implementing authentication and authorization in web applications. It offers a variety of features including user login, signup, password reset, and social login integrations. Auth0 simplifies the process of securing applications by providing a robust and scalable authentication service.

What are auth0's main functionalities?

User Login

This feature allows users to log in using their username and password. The code sample demonstrates how to use the password grant type to authenticate a user.

const auth0 = require('auth0');
const auth0Client = new auth0.AuthenticationClient({
  domain: 'YOUR_DOMAIN',
  clientId: 'YOUR_CLIENT_ID'
});

auth0Client.oauth.passwordGrant({
  username: '[e-mail]',
  password: 'password'
}, function(err, response) {
  if (err) {
    console.error(err);
  } else {
    console.log(response);
  }
});

User Signup

This feature allows new users to sign up for an account. The code sample demonstrates how to create a new user using the ManagementClient.

const auth0 = require('auth0');
const auth0Client = new auth0.ManagementClient({
  domain: 'YOUR_DOMAIN',
  clientId: 'YOUR_CLIENT_ID',
  clientSecret: 'YOUR_CLIENT_SECRET'
});

const data = {
  email: '[e-mail]',
  password: 'password',
  connection: 'Username-Password-Authentication'
};

auth0Client.createUser(data, function(err, user) {
  if (err) {
    console.error(err);
  } else {
    console.log(user);
  }
});

Password Reset

This feature allows users to reset their password. The code sample demonstrates how to request a password reset email.

const auth0 = require('auth0');
const auth0Client = new auth0.AuthenticationClient({
  domain: 'YOUR_DOMAIN',
  clientId: 'YOUR_CLIENT_ID'
});

auth0Client.requestChangePasswordEmail({
  email: '[e-mail]',
  connection: 'Username-Password-Authentication'
}, function(err, response) {
  if (err) {
    console.error(err);
  } else {
    console.log(response);
  }
});

Social Login

This feature allows users to log in using their social media accounts. The code sample demonstrates how to initiate a login with Google using the WebAuth client.

const auth0 = require('auth0');
const auth0Client = new auth0.WebAuth({
  domain: 'YOUR_DOMAIN',
  clientID: 'YOUR_CLIENT_ID'
});

auth0Client.authorize({
  connection: 'google-oauth2'
});

Other packages similar to auth0

passport

Passport is a popular authentication middleware for Node.js. It is highly flexible and modular, allowing developers to choose from a wide range of authentication strategies. Unlike Auth0, Passport requires more configuration and setup, but it offers greater control over the authentication process.

firebase

Firebase Authentication provides backend services for easy use of authentication in web and mobile apps. It supports email/password authentication, social login providers, and anonymous login. Firebase is a part of the Google Cloud Platform and offers a more integrated solution for apps already using other Firebase services.

okta

Okta is an enterprise-grade identity management service that provides secure authentication and authorization. It offers similar features to Auth0, including user management, social login, and multi-factor authentication. Okta is known for its robust security features and is often used in enterprise environments.

README

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

Documentation

• Docs Site - explore our docs site and learn more about Auth0

Getting Started

Requirements

This library supports the following tooling versions:

• Node.js: >=18

Installation

Using npm in your project directory run the following command:

npm install auth0

Configure the SDK

Authentication API Client

This client can be used to access Auth0's Authentication API.

import { AuthenticationClient } from 'auth0';

const auth0 = new AuthenticationClient({
  domain: '{YOUR_ACCOUNT}.auth0.com',
  clientId: '{OPTIONAL_CLIENT_ID}',
  clientSecret: '{OPTIONAL_CLIENT_SECRET}',
});

See more examples.

Management API Client

The Auth0 Management API is meant to be used by back-end servers or trusted parties performing administrative tasks. Generally speaking, anything that can be done through the Auth0 dashboard (and more) can also be done through this API.

Initialize your client class with a client ID, client secret and a domain.

import { ManagementClient } from 'auth0';

var management = new ManagementClient({
  domain: '{YOUR_TENANT_AND REGION}.auth0.com',
  clientId: '{YOUR_CLIENT_ID}',
  clientSecret: '{YOUR_CLIENT_SECRET}',
});

Or, initialize your client class with an API v2 token and a domain.

import { ManagementClient } from 'auth0';

var management = new ManagementClient({
  domain: '{YOUR_TENANT_AND REGION}.auth0.com',
  token: '{YOUR_API_V2_TOKEN}',
});

See more examples.

API Reference

• AuthenticationClient
• ManagementClient
• UserInfoClient

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

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