package
Auth0 Lock
npm install auth0-lockGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
:warning: Lock is built using React 18 from v12 onwards. Getting issues? Please submit a bug report.
:warning: From v12 onwards, we no longer publish to Bower.
We ensure browser compatibility in Chrome, Safari, Firefox and IE >= 11.
Install Lock into your project using npm:
npm install auth0-lockFrom CDN
<!-- Latest patch release (recommended for production) -->
<script src="https://cdn.auth0.com/js/lock/13.2.0/lock.min.js"></script>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
RS256and that "OIDC Conformant" is enabled. Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:
http://localhost:3000http://localhost:3000http://localhost:3000These 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 (see below). Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.
Create either an Auth0Lock or Auth0LockPasswordless instance, depending on your use case:
import { Auth0Lock } from 'auth0-lock';
const lock = new Auth0Lock('{YOUR_AUTH0_CLIENT_ID}', '{YOUR_AUTH0_DOMAIN}');import { Auth0LockPasswordless } from 'auth0-lock';
const lock = new Auth0LockPasswordless('{YOUR_AUTH0_CLIENT_ID}', '{YOUR_AUTH0_DOMAIN}');Configure a listener for the authenticated event to retrieve an access token and call show to display the Lock widget.
<button id="login">Click to Login</button>lock.on('authenticated', function (authResult) {
lock.getUserInfo(authResult.accessToken, function (error, profileResult) {
if (error) {
// Handle error
return;
}
accessToken = authResult.accessToken;
profile = profileResult;
// Update DOM
});
});
// Show the widget when the login button is clicked
document.getElementById('login').addEventListener('click', () => {
lock.show()
});.For other comprehensive examples and documentation on the configuration options, see the EXAMPLES.md document.
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
:warning: Note: We are no longer supporting requests for new features. Only requests for bug fixes or security patches will be considered.
To provide feedback or report a bug, please raise an issue on our issue tracker.
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.
auth0npm
devops+npm@auth0.com
oktajeffoktajeff
jeff.shuman@okta.com
bsmith-auth0
brian.s.smith@okta.com
sanjay.manikandhan
sanjay.manikandhan@okta.com
nirjo
nirmal.joishi@okta.com
niltorresatko
nil.torres@okta.com
jaskirat_atko
jaskirat.singh@okta.com
henry.mcardle
henry.mcardle@okta.com
nicolas.villalobos
nicolas.villalobos@okta.com
choah
choah.jung@auth0.com
josecarlos-chavez_atko
josecarlos.chavez@okta.com
skatko
saurabh.kumar@okta.com
tj.okta
tirone.pama@auth0.com
sgarcia-atko
sergio.garciaramos@okta.com
roger.chan
roger.chan@auth0.com
maaantone
michael.antone@auth0.com
lewisbyrne-okta
lewis.byrne@okta.com
tarunpreet.kaur
tarunpreet.kaur@okta.com
Estimated unpacked size across 52 packages.
27.3 MB
Includes dependencies.
^18.2.0 || ^19.0.0
19.3.1
^13.15.22
13.15.35
^2.3.2
2.5.1
^15.8.0
15.8.1
^2.19.0
2.19.0
^2.0.0
2.0.0
^4.4.5
4.4.5
^3.1.0
3.1.1