auth0.js

Auth0 headless browser sdk

Authentication / AuthorizationAPI wrapper / SDK
auth0/auth0.jsauth0-js

README

Client Side JavaScript toolkot for Auth0 API

Release Codecov
Downloads License CircleCI

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

Documentation


- Library docs - a complete reference and examples.
- Sample App - a sample application integrated with Auth0.
- Examples - code samples for common auth0-js authentication scenario's.
- Docs site - explore our docs site and learn more about Auth0.

Getting started


Installation


From CDN:

  1. ``` html
  3. <script src="https://cdn.auth0.com/js/auth0/9.19.2/auth0.min.js"></script>
  4. ```

From npm:

  1. ```sh
  2. npm install auth0-js
  3. ```

After installing the auth0-js module using npm, you'll need to bundle it up along with all of its dependencies, or import it using:

  1. ``` js
  2. import auth0 from 'auth0-js';
  3. ```

Configure the SDK


auth0.WebAuth


Provides support for all the authentication flows.

  1. ``` js
  2. var auth0 = new auth0.WebAuth({
  3.   domain: '{YOUR_AUTH0_DOMAIN}',
  4.   clientID: '{YOUR_AUTH0_CLIENT_ID}'
  5. });
  6. ```

auth0.Authentication


Provides an API client for the Auth0 Authentication API.

  1. ``` js
  2. var auth0 = new auth0.Authentication({
  3.   domain: '{YOUR_AUTH0_DOMAIN}',
  4.   clientID: '{YOUR_AUTH0_CLIENT_ID}'
  5. });
  6. ```

auth0.Management


Provides an API Client for the Auth0 Management API (only methods meant to be used from the client with the user token). You should use an access_token with the https://YOUR_DOMAIN.auth0.com/api/v2/ audience to make this work. For more information, read the user management section of the Auth0.js documentation.

  1. ``` js
  2. var auth0 = new auth0.Management({
  3.   domain: '{YOUR_AUTH0_DOMAIN}',
  4.   token: '{ACCESS_TOKEN_FROM_THE_USER}'
  5. });
  6. ```

API reference


auth0.webAuth


- constructor
- authorize(options)
- changePassword(options)
- checkSession(options, callback)
- login(options, callback)
- logout(options)
- parseHash(options, callback)
- passwordlessLogin(options, callback)
- passwordlessStart(options, callback)
- passwordlessVerify(options, callback)
- renderCaptcha(element, options, callback)
- renewAuth(options, callback)
- signup(options, callback)
- signupAndAuthorize(options, callback)
- validateAuthenticationResponse(options, parsedHash, callback)

auth0.Authentication


- buildAuthorizeUrl(options)
- buildLogoutUrl(options)
- delegation(options, callback)
- getChallenge(callback)
- getSSOData(withActiveDirectories, callback)
- login(options, callback)
- loginWithDefaultDirectory(options, callback)
- loginWithResourceOwner(options, callback)
- userInfo(token, callback)

auth0.Management


- getUser(userId, callback)
- linkUser(userId, secondaryUserId, callback)
- patchUserAttributes(userId, user, callback)
- patchUserMetadata(userId, userMetadata, callback)

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.


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.