auth0-js
v9.28.0
Published
Auth0 headless browser sdk
Downloads
796,307
Maintainers
Readme
📚 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:
<!-- Latest patch release -->
<script src="https://cdn.auth0.com/js/auth0/9.28.0/auth0.min.js"></script>
From npm:
npm install auth0-js
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:
import auth0 from 'auth0-js';
Configure the SDK
auth0.WebAuth
Provides support for all the authentication flows.
var auth0 = new auth0.WebAuth({
domain: '{YOUR_AUTH0_DOMAIN}',
clientID: '{YOUR_AUTH0_CLIENT_ID}'
});
auth0.Authentication
Provides an API client for the Auth0 Authentication API.
var auth0 = new auth0.Authentication({
domain: '{YOUR_AUTH0_DOMAIN}',
clientID: '{YOUR_AUTH0_CLIENT_ID}'
});
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.
var auth0 = new auth0.Management({
domain: '{YOUR_AUTH0_DOMAIN}',
token: '{ACCESS_TOKEN_FROM_THE_USER}'
});
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:
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.