Auth0 is an authentication broker that supports both social and enterprise identity providers, including Active Directory, LDAP, Google Apps, and Salesforce.
From CDN
<!-- Latest patch release (recommended for production) -->
<script src="https://cdn.auth0.com/js/lock/11.2.3/lock.min.js"></script>
From npm
npm install auth0-lock
Then you can import Auth0Lock
or Auth0LockPasswordless
like this:
import Auth0Lock from 'auth0-lock';
import { Auth0Lock } from 'auth0-lock';
import { Auth0LockPasswordless } from 'auth0-lock';
After installing the auth0-lock
module, you'll need bundle it up along with all of its dependencies. See examples for browserify and webpack.
It is expected that you use the development mode when working on your app, and the production mode when deploying your app to the users. You can find instructions for building your app for production with different module bundlers here.
If you are targeting mobile audiences, we recommended that you add:
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Lock uses Cross-Origin Authentication, make sure you understand the considerations you need to take into account by reading the Cross-Origin Authentication documentation.
Initializes a new instance of Auth0Lock
configured with your application clientID
and your account's domain
at Auth0. You can find this information in your application settings.
- clientId {String}: Your application clientId in Auth0.
- domain {String}: Your Auth0 domain. Usually your-account.auth0.com.
- options {Object}: Allows you to customize the dialog's appearance and behavior. See below for the details.
var clientId = "YOUR_AUTH0_APP_CLIENTID";
var domain = "YOUR_DOMAIN_AT.auth0.com";
var lock = new Auth0Lock(clientId, domain);
lock.on("authenticated", function(authResult) {
lock.getUserInfo(authResult.accessToken, function(error, profile) {
if (error) {
// Handle error
return;
}
localStorage.setItem("accessToken", authResult.accessToken);
localStorage.setItem("profile", JSON.stringify(profile));
// Update DOM
});
});
Initializes a new instance of Auth0LockPasswordless
configured with your application clientID
and your account's domain
at Auth0. You can find this information in your application settings.
- clientId {String}: Your application clientId in Auth0.
- domain {String}: Your Auth0 domain. Usually your-account.auth0.com.
- options {Object}: Allows you to customize the dialog's appearance and behavior. See below for the details.
var clientId = "YOUR_AUTH0_APP_CLIENTID";
var domain = "YOUR_DOMAIN_AT.auth0.com";
var lock = new Auth0LockPasswordless(clientId, domain);
lock.on("authenticated", function(authResult) {
lock.getUserInfo(authResult.accessToken, function(error, profile) {
if (error) {
// Handle error
return;
}
localStorage.setItem("accessToken", authResult.accessToken);
localStorage.setItem("profile", JSON.stringify(profile));
// Update DOM
});
});
Once the user has logged in and you are in possesion of an access token, you can obtain the profile with getUserInfo
.
- accessToken {String}: User access token.
- callback {Function}: Will be invoked after the user profile been retrieved.
lock.getUserInfo(accessToken, function(error, profile) {
if (!error) {
alert("hello " + profile.name);
}
});
Lock will emit events during its lifecycle.
show
: emitted when Lock is shown. Has no arguments.hide
: emitted when Lock is hidden. Has no arguments.unrecoverable_error
: emitted when there is an unrecoverable error, for instance when no connection is available. Has the error as the only argument.authenticated
: emitted after a successful authentication. Has the authentication result as the only argument.authorization_error
: emitted when authorization fails. Has error as the only argument.hash_parsed
: every time a new Auth0Lock object is initialized in redirect mode (the default), it will attempt to parse the hash part of the url looking for the result of a login attempt. This is a low level event for advanced use cases and authenticated and authorization_error should be preferred when possible. After that this event will be emitted withnull
if it couldn't find anything in the hash. It will be emitted with the same argument as theauthenticated
event after a successful login or with the same argument asauthorization_error
if something went wrong. This event won't be emitted in popup mode because there is no need to parse the url's hash part.forgot_password ready
: emitted when the "Forgot password" screen is shown.forgot_password submit
: emitted when the user clicks on the submit button of the "Forgot password" screen.signin submit
: emitted when the user clicks on the submit button of the "Login" screen.signup submit
: emitted when the user clicks on the submit button of the "Sign up" screen.federated login
: emitted when the user clicks on a social connection button. Has the connection name and the strategy as arguments.
Displays the widget, allowing to override some options.
- options {Object}: Allows you to customize some aspect of the dialog's appearance and behavior. The options allowed in here are subset of the options allowed in the constructor and will override them:
allowedConnections
,auth.params
,allowLogin
,allowSignUp
,allowForgotPassword
,initialScreen
,rememberLastLogin
andflashMessage
. See below for the details. Keep in mind thatauth.params
will be fully replaced and not merged.
// without options
lock.show();
// will override the allowedConnections option passed to the constructor, if any
lock.show({allowedConnections: ["twitter", "facebook"]})
// will override the entire auth.params object passed to the constructor, if any
lock.show({auth: {params: {state: 'auth_state'}}})
If you set the auth.autoParseHash option to false
, you'll need to call this method to complete the authentication flow. This method is useful when you're using a client-side router that uses a #
to handle urls (angular2 with useHash
or react-router with hashHistory
).
- hash {String}: The hash fragment received from the redirect.
- callback {Function}: Will be invoked after the parse is done. Has an error (if any) as the first argument and the authentication result as the second one. If there is no hash available, both arguments will be
null
.
lock.resumeAuth(hash, function(error, authResult) {
if (error) {
alert("Could not parse hash");
}
console.log(authResult.accessToken);
});
Logs out the user
- options {Object}: This is optional and follows the same rules as this
lock.logout({ returnTo: 'https://myapp.com/bye-bye' });
The checkSession method allows you to acquire a new token from Auth0 for a user who is already authenticated against the hosted login page for your domain. The method accepts any valid OAuth2 parameters that would normally be sent to authorize. In order to use this method, you have to enable Web Origins for your client. For more information, see Using checkSession to acquire new tokens.
- options {Object}: OAuth2 options object to send to Auth0's servers.
- callback {Function}: Will be invoked after the response from the server is returned. Has an error (if any) as the first argument and the authentication result as the second one.
lock.checkSession({}, function (error, authResult) {
if (error || !authResult) {
lock.show();
} else {
// user has an active session, so we can use the accessToken directly.
lock.getUserInfo(authResult.accessToken, function (error, profile) {
console.log(error, profile);
});
}
});
The appearance of the widget and the mechanics of authentication can be customized with an options
object which has one or more of the following properties. Each method that opens the dialog can take an options
object as its first argument.
- allowedConnections {Array}: List of connection that will be available to perform the authentication. It defaults to all enabled connections.
- autoclose {Boolean}: Determines whether or not the Lock will be closed automatically after a successful sign in. If the Lock is not
closable
it won't be closed even if this option is set totrue
. Defaults tofalse
. - autofocus {Boolean}: Determines whether or not the first input on the screen, that is the email or phone number input, should have focus when the Lock is displayed. Defaults to
false
when acontainer
option is provided or the Lock is being render on a mobile device. Otherwise it defaults totrue
. - avatar {Object}: Determines whether or not an avatar and a user name should be displayed on the Lock's header once an email or username has been entered and how to obtain it. By default avatars are fetched from Gravatar. Supplying
null
will disable the functionality. To fetch avatar from other provider see below. - container {String}: The
id
of the html element where the Lock will be rendered. This makes the Lock appear inline instead of in a modal window. - language {String}: Specifies the language of the widget. Defaults to
"en"
. Supported languages are:de
: Germanen
: Englishes
: Spanishit
: Italiannb
: Norwegian bokmålpt-BR
: Brazilian Portugueseru
: Russianzh
: Chineseja
: Japanese- Check all the available languages
- languageDictionary {Object}: Allows you to customize every piece of text displayed in the Lock. Defaults to
{}
. See below Language Dictionary Specification for the details. - closable {Boolean}: Determines whether or not the Lock can be closed. When a
container
option is provided its value is alwaysfalse
, otherwise it defaults totrue
. - popupOptions {Object}: Allows you to customize the location of the popup in the screen. Any position and size feature allowed by
window.open
is accepted. Defaults to{}
. - rememberLastLogin {Boolean}: Determines whether or not to show a screen that allows you to quickly log in with the account you used the last time when the
initialScreen
option is set to to"login"
(the default). Defaults totrue
. - flashMessage {Object}: Shows an
error
orsuccess
flash message when Lock is shown.- type {String}: The message type, it should be
error
orsuccess
. - text {String}: The text to show.
- type {String}: The message type, it should be
- allowAutocomplete {Boolean}: Determines whether or not the the email or username inputs will allow autocomplete (
<input autocomplete />
). Defaults tofalse
. - scrollGlobalMessagesIntoView {Boolean}: Determines whether or not a globalMessage should be scrolled into the user's viewport. Defaults to
true
. - allowShowPassword {Boolean}: Determines whether or not add a checkbox to show the password when typing it. Defaults to
false
.
Theme options are grouped in the theme
property of the options
object.
var options = {
theme: {
labeledSubmitButton: false,
logo: "https://example.com/assets/logo.png",
primaryColor: "green",
authButtons: {
connectionName: {
displayName: "...",
primaryColor: "...",
foregroundColor: "...",
icon: "https://.../logo.png"
}
}
}
};
- labeledSubmitButton {Boolean}: Indicates whether or not the submit button should have a label. Defaults to
true
. When set tofalse
a icon will be shown. The labels can be customized through thelanguageDictionary
. - logo {String}: Url for an image that will be placed in the Lock's header. Defaults to Auth0's logo.
- primaryColor {String}: Defines the primary color of the Lock, all colors used in the widget will be calculated from it. This option is useful when providing a custom
logo
to ensure all colors go well together with the logo's color palette. Defaults to"#ea5323"
. - authButtons {Object}: Allows the customization of the custom oauth2 login buttons.
- displayName {String}: The name to show instead of the connection name.
- primaryColor {String}: The button's background color. Defaults to
"#eb5424"
. - foregroundColor {String}: The button's text color. Defaults to
"#FFFFFF"
. - icon {String}: The icon's url for the connection. For example:
"https://site.com/logo.png"
.
Authentication options are grouped in the auth
property of the options
object. The default scope used by Lock is openid profile email
.
var options = {
auth: {
params: {
param1: "value1",
scope: "openid profile email"
},
autoParseHash: true,
redirect: true,
redirectUrl: "some url",
responseMode: "form_post",
responseType: "token",
sso: true,
connectionScopes: {
connectionName: [ 'scope1', 'scope2' ]
}
}
};
- params {Object}: Specifies extra parameters that will be sent when starting a login. Defaults to
{}
. - autoParseHash {Boolean}: When set to
true
, Lock will parse thewindow.location.hash
string when instantiated. If set tofalse
, you'll have to manually resume authentication using the resumeAuth method. - redirect {Boolean}: When set to
true
, the default, redirect mode will be used. Otherwise, popup mode is chosen. See below for more details. - redirectUrl {String}: The url Auth0 will redirect back after authentication. Defaults to the empty string
""
(no redirect URL). - responseMode {String}: Should be set to
"form_post"
if you want the code or the token to be transmitted via an HTTP POST request to theredirectUrl
instead of being included in its query or fragment parts. Otherwise, it should be ommited. - responseType {String}: Should be set to
"token"
for Single Page Applications, and"code"
otherwise. Also,"id_token"
is supported for the first case. Defaults to"code"
whenredirectUrl
is provided, and to"token"
otherwise. - sso {Boolean}: Determines whether Single Sign On is enabled or not in Lock. The Auth0 SSO session will be created regardless of this option if SSO is enabled for your client or tenant.
- connectionScopes {Object}: Allows you to set scopes to be sent to the oauth2/social connection for authentication.
- socialButtonStyle {String}: Determines the size of the buttons for the social providers. Possible values are
"big"
and"small"
. The default style depends on the connections that are available:- If only social connections are available, it will default to
"big"
when there are 5 connections at most, and default to"small"
otherwise. - If connections from types other than social are also available, it will default to
"big"
when there are 3 social connections at most, and default to"small"
otherwise.
- If only social connections are available, it will default to
- additionalSignUpFields {Array}: Allows you to provide extra input fields during sign up. See below more for details. Defaults to
[]
. - allowLogin {Boolean}: When set to
false
the widget won't display the login screen. This is useful if you want to use the widget just for sign ups (the login and sign up tabs in the sign up screen will be hidden) or to reset passwords (the back button in the forgot password screen will be hidden). In such cases you may also need to specify theinitialScreen
,allowForgotPassword
andallowSignUp
options. It defaults totrue
. - allowForgotPassword {Boolean}: When set to
false
hides the "Don't remember your password?" link in the login screen, making the forgot password screen unreachable. Defaults totrue
. Keep in mind that if you are using a database connection with a custom database which doesn't have a change password script the forgot password screen won't be available. - allowSignUp {Boolean}: When set to
false
hides the login and sign up tabs in the login screen, making the sign up screen unreachable. Defaults totrue
. Keep in mind that if the database connection has sign ups disabled or you are using a custom database which doesn't have a create script, then the sign up screen won't be available. - defaultDatabaseConnection {String}: Specifies the database connection that will be used when there is more than one available.
- initialScreen {String}: Name of the screen that will be shown when the widget is opened. Valid values are
"login"
,"signUp"
, and"forgotPassword"
. If this option is left unspecified, the widget will pick the first screen that is available from the previous list. If you setinitialScreen
to"forgotPassword"
we recommend that you setallowLogin
to"false"
, otherwise a back button will be shown in the forgot password screen and it might not be clear to the user where that back button will take them. - loginAfterSignUp {Boolean}: Determines whether or not the user will be automatically signed in after a successful sign up. Defaults to
true
. - forgotPasswordLink {String}: URL for a page that allows the user to reset her password. When set to a non-empty string, the user will be linked to the provided URL when clicking the "Don't remember your password?" link in the login screen.
- mustAcceptTerms {Boolean}: When set to
true
displays a checkbox input along with the terms and conditions that must be checked before signing up. The terms and conditions can be specified via thelanguageDictionary
option, see the example below. Defaults tofalse
. - prefill {Object}: Allows you to set the initial value for the email and/or username inputs, e.g.
{prefill: {email: "[email protected]", username: "someone"}}
. When omitted no initial value will be provided. - signUpLink {String}: URL for a page that allows the user to sign up. When set to a non-empty string, the user will be linked to the provided URL when clicking the sign up tab in the login screen.
- usernameStyle {String}: Determines what will be used to identify the user for a Database connection that has the
requires_username
flag set, otherwise it will be ignored. Possible values are"username"
and"email"
and by default bothusername
andemail
are allowed.
- defaultEnterpriseConnection {String}: Specifies the enterprise connection which allows you to login using an username and a password that will be used when there is more than one available or there is a database connection. If a
defaultDatabaseConnection
is provided the database connection will be used and this option will be ignored.
var options = {
container: "myContainer",
closable: false,
languageDictionary: {
signUpTerms: "I agree to the <a href='/terms' target='_new'>terms of service</a> and <a href='/privacy' target='_new'>privacy policy</a>.",
title: "My Company",
},
autofocus: false
};
- configurationBaseUrl {String}: Overrides client settings base url. By default it uses Auth0's CDN url when
domain
has the format*.auth0.com
. Otherwise, it uses the provideddomain
. - languageBaseUrl {String}: Overrides the language source url for Auth0's provided translations. By default it uses to Auth0's CDN url
https://cdn.auth0.com
. - hashCleanup {Boolean}: When enabled, it will remove the hash part of the callback url after the user authentication. Defaults to
true
. - connectionResolver {Function}: When in use, provides an extensibility point to make it possible to choose which connection to use based on the username information. Has
username
,context
andcallback
as parameters. The callback expects an object like:{type: 'database', name: 'connection name'}
. This only works for database connections. Keep in mind that this resolver will run in the username/email input'sonBlur
event, so keep it simple and fast. This is a beta feature. If you find a bug, please open a github issue.
var options = {
connectionResolver: function (username, context, cb) {
var domain = username.includes('@') && username.split('@')[1];
if (domain) {
// If the username is [email protected], the connection used will be the `auth0.com` connection.
// Make sure you have a database connection with the name `auth0.com`.
cb({ type: 'database', name: domain });
} else {
// Use the default approach to figure it out the connection
cb(null);
}
}
}
A language dictionary is an object that allows you to customize every piece of text the Lock needs to display. For instance, the following code will change the title displayed in the header and the placeholder for the email field.
var options = {
languageDictionary: {
emailInputPlaceholder: "please enter you email",
title: "My Company"
},
};
Extra input fields can be added to the sign up screen with the additionalSignUpFields
option. Every input must have a name
and a placeholder
, and an icon
url can also be provided. Also, the initial value can be provided with the prefill
option, which can be a string with the value or a function that obtains it. Other options depend on the type of the field, which is defined via the type
option and defaults to "text"
.
Additional sign up fields are rendered below the default fields in the order they are provided.
A validator
function can also be provided.
var options = {
additionalSignUpFields: [{
name: "address",
placeholder: "enter your address",
// The following properties are optional
icon: "https://example.com/assests/address_icon.png",
prefill: "street 123",
validator: function(address) {
return {
valid: address.length >= 10,
hint: "Must have 10 or more chars" // optional
};
}
}]
}
To specify a select field type: "select"
needs to be provided along with the options
property.
var options = {
additionalSignUpFields: [{
type: "select",
name: "location",
placeholder: "choose your location",
options: [
{value: "us", label: "United States"},
{value: "fr", label: "France"},
{value: "ar", label: "Argentina"}
],
// The following properties are optional
icon: "https://example.com/assests/location_icon.png",
prefill: "us"
}]
}
The options
and the prefill
value can be provided through a function.
var options = {
additionalSignUpFields: [{
type: "select",
name: "location",
placeholder: "choose your location",
options: function(cb) {
// obtain options, in case of error you call cb with the error in the
// first arg instead of null
cb(null, options);
},
icon: "https://example.com/assests/location_icon.png",
prefill: function(cb) {
// obtain prefill, in case of error you call cb with the error in the
// first arg instead of null
cb(null, prefill);
}
}]
}
To specify a checkbox field use: type: "checkbox"
The prefill
value can determine the default state of the checkbox and it is required.
var options = {
additionalSignUpFields: [{
type: "checkbox",
name: "newsletter",
prefill: "true",
placeholder: "I hereby agree that I want to receive marketing emails from your company",
}]
}
Lock can show avatars fetched from anywhere. A custom avatar provider can be specified with the avatar
option by passing an object with the keys url
and displayName
. Both properties are functions that take an email and a callback function.
var options = {
avatar: {
url: function(email, cb) {
// obtain url for email, in case of error you call cb with the error in
// the first arg instead of null
cb(null, url);
},
displayName: function(email, cb) {
// obtain displayName for email, in case of error you call cb with the
// error in the first arg instead of null
cb(null, displayName);
}
}
};
A popup window can be displayed instead of redirecting the user to a social provider website. While this has the advantage of preserving page state, it has some issues. Often times users have popup blockers that prevent the login page from even displaying. There are also known issues with mobile browsers. For example, in recent versions of Chrome on iOS, the login popup does not close properly after login. For these reasons, we encourage developers to avoid this mode, even with Single Page Apps.
If you decide to use popup mode you can activate it by passing the option auth: {redirect: false}
when constructing Auth0Lock
.
var clientId = "YOUR_AUTH0_APP_CLIENTID";
var domain = "YOUR_DOMAIN_AT.auth0.com";
var options = {
auth: {
redirect: false
}
};
var lock = new Auth0Lock(clientId, domain, options);
lock.show();
More information can be found in Auth0's documentation.
We ensure browser compatibility in Chrome, Safari, Firefox and IE >= 10. We currently use zuul along with Saucelabs to run integration tests on each push.
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.
This project is licensed under the MIT license. See the LICENSE file for more info.