options
envoyé au constructeur. Ces options peuvent modifier le comportement du gadget logiciel Lock, la façon dont il gère les connexions, les champs d’inscription supplémentaires dont vous avez besoin pour votre projet, les valeurs de langue et de texte, les couleurs et les images du gadget logiciel, et bien plus encore. Consultez l’index ci-dessous si vous savez ce que vous recherchez, ou parcourez les options pour plus de détails.
UI
Option | Description |
---|---|
allowAutocomplete | Activer ou désactiver la saisie automatique de l’adresse courriel ou du nom d’utilisateur |
allowPasswordAutocomplete | Activer ou désactiver la saisie automatique du mot de passe |
allowShowPassword | Précise si l’utilisateur peut choisir d’afficher le mot de passe lors de la saisie |
allowedConnections | Liste des connexions qui seront offertes pour effectuer l’authentification |
autoclose | Précise si Lock se ferme après une connexion |
autofocus | Précise si le premier champ de saisie est mis en évidence |
avatar | Précise si un avatar et un nom d’utilisateur doivent être affichés dans l’en-tête de Lock une fois qu’une adresse courriel ou un nom d’utilisateur a été saisi(e), et comment l’obtenir |
closable | Détermine si Lock peut être fermé |
container | L’élément HTML où Lock sera inclus. Lock sera incorporé à l’écran plutôt que dans une fenêtre modale |
flashMessage | Affiche un message temporaire error ou success lorsque Lock est affiché |
language | Précise la langue du gadget logiciel |
languageDictionary | Texte personnalisé utilisé pour les éléments du gadget logiciel (comme les étiquettes et les paramètres fictifs) |
popupOptions | Personnalisez l’emplacement de la fenêtre contextuelle à l’écran |
rememberLastLogin | Afficher ou masquer un écran pour vous permettre de vous connecter rapidement avec le compte que vous avez utilisé la dernière fois |
scrollGlobalMessagesIntoView | Précise si un globalMessage doit défiler dans la fenêtre de l’utilisateur |
Thème
Ces options sont groupées dans la propriététheme
de l’objet options
.
Option | Description |
---|---|
authButtons | Personnaliser l’apparence de certaines touches de connexion |
labeledSubmitButton | que la touche de soumission comporte ou non du texte |
logo | Quel logo utiliser? |
primaryColor | Couleur de la touche principale du gadget logiciel |
Authentification
Les options d’authentification sont groupées dans la propriétéauth
de l’objet options
.
Option | Description |
---|---|
[public] (#audience-string-) | L’API qui consommera votre Jeton d’accès |
autoParseHash | S’il faut ou non analyser automatiquement le hachage et continuer |
[connectionScopes] (#connectionscopes-object-) | Spécifier les permissions de connexion |
[params] (#params-object-) | Option pour envoyer des paramètres à la connexion |
[redirect] (#redirect-boolean-) | Utiliser ou non le mode de redirection |
redirect URL | L’URL pour rediriger vers après l’authentification |
[responseMode] (#responsemode-string-) | Option pour envoyer une réponse en POST |
[responseType] (#responsetype-string-) | Réponse sous forme de code ou de jeton |
[ssso] (#sso-boolean-) | Détermine si l’authentification unique (SSO) est activée ou non dans Lock |
Base de données
Option | Description |
---|---|
additionalSignUpFields | Champs supplémentaires collectés lors de l’inscription. |
allowLogin | Permettre ou ne pas permettre la connexion au gadget logiciel. |
allowForgotPassword | Permettre ou ne pas permettre la réinitialisation du mot de passe du gadget logiciel. |
allowSignUp | Permettre ou ne pas permettre l’inscription au gadget logiciel. |
defaultDatabaseConnection | Connexion à la DB montrée par défaut. |
initialScreen | Choix de l’écran affiché à l’ouverture du widget. |
loginAfterSignUp | Permettre ou ne pas permettre la connexion automatique suite à l’inscription. |
forgotPasswordLink | Lien menant vers une page de réinitialisation du mot de passe. |
showTerms | Spécifie si les conditions devraient être affichées lors de l’inscription. |
mustAcceptTerms | Spécifie si les conditions doivent être acceptées (case à cocher). |
prefill | Pré-remplissage des champs courriel et nom d’utilisateur. |
signUpLink | Définir une URL à déclencher lorsque l’utilisateur clique sur « sign up » (Inscription) |
usernameStyle | Limiter les valeurs acceptées par le champ username (nom d’utilisateur) à « username » (nom d’utilisateur) ou à « email » (courriel). |
Entreprise
Option | Description |
---|---|
defaultEnterpriseConnection | Spécifie une connexion si plus d’une est présente |
Sans mot de passe
Option | Description |
---|---|
passwordlessMethod | Lorsque vous utilisez Auth0LockPasswordless avec une connexion courriel, vous pouvez utiliser cette option pour choisir entre l’envoi d’un code ou un magic link pour authentifier l’utilisateur |
Autres
Option | Description |
---|---|
configurationBaseUrl | Remplacer l’URL de base de votre application |
languageBaseUrl | Remplacer l’URL de base de votre fichier de langue |
hashCleanup | Remplacer la suppression par défaut du hachage de l’URL |
connectionResolver | Fonction de rappel facultative pour choisir une connexion sur la base des informations relatives au nom d’utilisateur |
Options UI
allowAutocomplete
Détermine si les champs du courriel ou du nom d’utilisateur autoriseront ou non la saisie semi-automatique (<input autocomplete />
). La valeur par défaut est false.
allowAutocomplete: true
allowPasswordAutocomplete
Détermine si le champ du mot de passe autorisera ou non la saisie semi-automatique (<input autocomplete />
). La valeur par défaut est false
.
Réglez allowPasswordAutocomplete
à true
pour la prise en charge du gestionnaire de mots de passe et pour éviter d’autres cas de comportement indésirable.
allowPasswordAutocomplete: true
allowShowPassword
Cette option détermine s’il faut ou non ajouter une case à cocher à l’interface utilisateur qui, lorsqu’elle est sélectionnée, permettra à l’utilisateur d’afficher son mot de passe lors de sa saisie. L’option par défaut estfalse
.
allowShowPassword: true
Lock avec le réglage allowShowPassword
](/docs/images/ et basculez pour afficher le mot de passe :

allowedConnections
Tableau de connexions qui seront utilisées pour les actions designin|signup|reset
. Par défaut pour toutes les connexions activées.
allowedConnections: ['Username-Password-Authentication']
allowedConnections: ['twitter', 'facebook', 'linkedin']
allowedConnections: ['qraftlabs.com']
Exemples de allowedConnections
:](/docs/images/


autoclose
Détermine si Lock sera fermé automatiquement après une connexion réussie. La valeur par défaut est false. Si Lock n’est pasclosable
, il ne sera pas fermé, même si cette option est définie sur true.
autoclose: true
autofocus
Si c’est true, le focus est défini sur le premier champ du gadget logiciel. Par défaut surfalse
lorsqu’il est rendu sur un appareil mobile, ou si une option container
est fournie; par défaut sur true
dans tous les autres cas.
autofocus: false
avatar
Par défaut, Gravatar est utilisé pour récupérer l’avatar et le nom d’affichage de l’utilisateur, mais vous pouvez les obtenir de n’importe où avec l’optionavatar
.
null
.
avatar: null
Comportement par défaut avec](/docs/images/:

closable
Détermine si le verrou peut être fermé ou non. Lorsqu’une option decontainer
est fournie, sa valeur est toujours false
, sinon elle est true
par défaut.
closable: false
](/docs/images/

container
L’identifiant
de l’élément html où le gadget logiciel sera affiché.
Cela fait apparaître le gadget logiciel en ligne dans votre div
plutôt que dans une fenêtre contextuelle modale.
language
Spécifie la langue du gadget logiciel. La valeur par défaut est « en ». Consultez le répertoire d’internationalisation pour une liste actuelle des langues fournies.language: 'es'
](/docs/images/

languageDictionary
Permet de personnaliser chaque élément de texte affiché dans Lock. La valeur par défaut est . Voir Spécification du dictionnaire de langue en anglais pour la liste complète des valeursLanguageDictionary
pouvant être modifiées avec cet objet.
rememberLastLogin
Détermine s’il faut ou non afficher un écran qui vous permet de vous connecter rapidement avec le compte que vous avez utilisé la dernière fois. Demande des données d’authentification unique () et active un message Dernière fois que vous vous êtes connecté avec. Par défaut surtrue
. Ces informations proviennent de la session Auth0 de l’utilisateur, cette capacité durera donc aussi longtemps que sa session Auth0 (qui est configurable).
rememberLastLogin: false
Pour les nouveaux locataires Seamless SSO est automatiquement activé. Une fois cette option activée, l’option RememberLastLogin
ne sera pas pertinente, car si une session est en place, la page de connexion universelle ne sera pas affichée du tout. L’utilisation de Seamless SSO est fortement recommandée, car elle offre une expérience d’authentification transparente : les utilisateurs se connectent une seule fois et n’auront pas à saisir à nouveau leurs informations d’identification lorsqu’ils naviguent dans les applications que vous avez créées ou dans des applications tierces. Si l’utilisateur n’est pas connecté, il sera redirigé vers l’écran de connexion, comme prévu. De plus, le message Dernière fois que vous vous êtes connecté avec ne sera pas disponible dans les circonstances suivantes :
- Vous avez utilisé Lock sur une page de connexion hébergée avec la session établie à l’aide de l’authentification sans mot de passe.
- Vous avez utilisé Lock dans un scénario de connexion intégré où
responseType: code
(indiquant le flux de code d’autorisation, utilisé pour les applications Web standard).
scrollGlobalMessagesIntoView
Détermine si unglobalMessage
doit ou non défiler dans la fenêtre d’affichage de l’utilisateur. Par défaut sur vrai
.
scrollGlobalMessagesIntoView: false
Options de thème
Ces options sont groupées dans la propriététheme
de l’objet options
.
authButtons
Permet la personnalisation des boutons dans Lock avec des connexions OAuth2 personnalisées. Chaque connexion personnalisée dont vous souhaitez personnaliser le bouton doit être répertoriée par nom, chacune avec son propre ensemble de paramètres. Les paramètres personnalisables sont énumérés ci-dessous :- displayName : Le nom à afficher à la place du nom de la connexion lors de la création du titre du bouton, par exemple
LOGIN WITH MYCONNECTION
(pour la connexion). - primaryColor : couleur d’arrière-plan du bouton. La valeur par défaut est
#eb5424
. - foregroundColor : couleur du texte du bouton. La valeur par défaut est
#FFFFFF
. - icon : l’URL de l’icône de cette connexion. Par exemple :
http://site.com/logo.png
.
labeledSubmitButton
Cette option indique si le bouton de soumission doit avoir ou non une étiquette et la valeur par défaut esttrue
. Lorsqu’il est défini sur false
, une icône s’affichera à la place.
audience
L’optionaudience
indique l’API qui consommera le jeton d’accès reçu après l’authentification.
autoParseHash
LorsqueautoParseHash
est défini sur true
, Lock analysera la chaîne window.location.hash
une fois instanciée. S’il est défini sur false
, vous devrez reprendre manuellement l’authentification à l’aide de la méthode summaryAuth.
connectionScopes
Cette option vous permet de définir les permissions à envoyer à la connexion oauth2/média social pour l’authentification.params
Vous pouvez envoyer des paramètres lors du démarrage d’une connexion en les ajoutant à l’objet options. L’exemple ci-dessous ajoute un paramètrestate
avec une valeur égale à foo
et ajoute également un paramètre scope
(qui inclut la permission, puis les attributs demandés).
redirect
La valeur par défaut est true. Lorsqu’il est défini sur true, le mode de redirection sera utilisé. S’il est défini sur false, le mode fenêtre contextuelle est choisi.redirectUrl
L’URL Auth0 de redirectiion après l’authentification. La valeur par défaut est le lien vide "" (pas d’URL de redirection).redirectUrl
est fourni (défini sur une valeur non vide), l’option responseType
sera définie par défaut sur code
si elle n’est pas définie manuellement.
responseMode
Doit être défini sur« form_post »
si vous souhaitez que le code ou le jeton soit transmis via une requête HTTP POST à redirectUrl
, au lieu d’être inclus dans ses parties de requête ou de fragment.
Sinon, cette option doit être omise et est omise par défaut.
responseType
La valeurresponseType
doit être définie sur « token » pour les applications à page unique et sur « code » dans le cas contraire. La valeur par défaut est « code » lorsque redirectUrl est fourni, et « token » dans le cas contraire.
responsetype
est défini sur code
, Lock n’affichera jamais un message Dernière fois que vous vous êtes connecté avec et demandera toujours à l’utilisateur ses informations d’identification.
sso
La valeur par défaut est vrai. Lorsqu’il est défini sur true, il active l’authentification unique dans Lock.Options de base de données
additionalSignUpFields
Des champs de saisie supplémentaires peuvent être ajoutés à l’écran d’inscription avec l’optionadditionalSignUpFields
. Chaque option ajoutée de cette manière sera ensuite ajoutée aux user_metadata
de cet utilisateur. Pour en savoir davantage, consultez Comprendre le fonctionnement des métadonnées dans les profils utilisateurs. Chaque entrée doit avoir un name
et un paramètre fictif
, et l’URL d’une icône
peut également être fournie. De plus, la valeur initiale peut être fournie avec l’option prefill
, qui peut être un lien avec la valeur ou une fonction qui l’obtient. Les autres options dépendent du type du champ, qui est défini via l’option type et par défaut « texte ».
L’option additionalSingUpFields sert uniquement pour l’inscription à une base de données
L’option
additionalSingUpFields
sert uniquement pour les inscriptions à une base de données Si vous avez des inscriptions provenant de connexions sociales, vous pouvez demander des informations supplémentaires après l’inscription des utilisateurs (consultez cette page à propos de l’inscription personnalisée pour en savoir plus). Vous pouvez utiliser la clé databaseAlternativeSignupInstructions
i18n pour afficher ces instructions.Champs de texte
Les champs de texte sont le type par défaut de champ de connexion supplémentaire. À noter qu’une fonctionvalidator
peut également être fournie.
validator
, le champ de texte sera obligatoire. Si vous souhaitez rendre le champ de texte facultatif, utilisez un validateur qui renvoie toujours true
comme ceci :
storage: 'root'
. Seul un sous-ensemble de valeurs peut être stocké de cette manière. La liste des attributs pouvant être ajoutés à votre profil root est ici. Par défaut, chaque champ de connexion supplémentaire est stocké dans l’objet user_metadata.
options
pour les champs select
doivent respecter le format suivant :
{label: “non empty string”, value: “non empty string”}
, et au moins une option doit être définie.
Les valeurs options
et prefill
peuvent être fournies via une fonction :
Champ de case à cocher
Le troisième type de champ de connexion personnalisé esttype: "checkbox"
. La valeur préremplissage
peut déterminer l’état par défaut de la case à cocher (true
ou false
), et elle est obligatoire.
Champ invisible
Le champ de connexiontype "hidden"
: vous permettra d’utiliser une entrée cachée avec une valeur fixe.
additionalSignUpFields
pour les modèles de courriels, comme une option pour les préférences linguistiques, dont la valeur pourrait ensuite être utilisée pour définir la langue des communications par courriel modélisées.
allowLogin
Lorsqu’il est défini surfalse
, le gadget logiciel n’affichera pas l’écran de connexion. Ceci est utile si vous souhaitez utiliser le gadget logiciel uniquement pour les inscriptions (les onglets de connexion et d’inscription dans l’écran d’inscription seront masqués) ou pour réinitialiser les mots de passe (le bouton de retour dans l’écran de mot de passe oublié sera masqué). Dans de tels cas, vous devrez peut-être également spécifier les options initialScreen
, AllowForgotPassword
et AllowSignUp
. La valeur par défaut est true
.
allowLogin: false
](/docs/images/

allowForgotPassword
Lorsqu’il est défini sur false,allowForgotPassword
masque le lien « Vous ne vous souvenez pas de votre mot de passe? » dans l’écran de connexion, rendant l’écran Mot de passe oublié inaccessible. La valeur par défaut est vrai. Si vous utilisez une connexion à une base de données personnalisée qui ne dispose pas d’un script de modification du mot de passe, l’écran Mot de passe oublié ne sera pas disponible.
allowForgotPassword: false
](/docs/images/

allowSignUp
Lorsqu’il est défini surfalse
, masque les onglets de connexion et d’inscription dans l’écran de connexion, rendant l’écran de connexion inaccessible. Par défaut sur vrai
. Gardez à l’esprit que si la connexion à la base de données a désactivé les inscriptions ou si vous utilisez une base de données personnalisée qui ne dispose pas de script de création, l’écran de connexion ne sera pas disponible.
Gardez également à l’esprit que cette option contrôle uniquement l’apparence côté client et n’arrête pas complètement les nouvelles connexions de visiteurs anonymes déterminés. Si vous souhaitez empêcher complètement la connexion de nouveaux utilisateurs, vous devez utiliser l’option Disable Sign Ups (Désactiver les connexions) dans le tableau de bord, dans les paramètres de connexion.
allowSignUp: false
](/docs/images/

defaultDatabaseConnection
Spécifie la connexion à la base de données qui sera utilisée lorsqu’il y en a plusieurs disponibles.defaultDatabaseConnection: 'test-database'
initialScreen
Le nom de l’écran qui sera affiché à l’ouverture du gadget logiciel. Les valeurs valides sontconnexion
, s’inscrire
et Mot de passe oublié
. Si cette option n’est pas spécifiée, le gadget logiciel affichera par défaut le premier écran disponible dans cette liste.
initialScreen: 'forgotPassword'
loginAfterSignUp
Détermine si l’utilisateur sera automatiquement connecté ou non après une inscription réussie. Par défaut survrai
.
loginAfterSignUp: false
forgotPasswordLink
Définissez l’URL d’une page qui permet à l’utilisateur de réinitialiser son mot de passe. Lorsqu’il est défini sur un lien non vide, l’utilisateur sera redirigé vers l’URL fournie lorsqu’il cliquera sur le lien « Vous ne vous souvenez pas de votre mot de passe? dans l’écran de connexion.forgotPasswordLink: 'https://yoursite.com/reset-password'
showTerms
Lorsqu’il est défini surtrue
, affiche le lien languageDictionary.signUpTerms
. Par défaut sur vrai
.
showTerms: false
mustAcceptTerms
Une fois définie surtrue
, affiche une case à cocher à côté des modalités qui doivent être vérifiées avant de procéder à l’inscription. Les modalités peuvent être spécifiées à l’aide de l’option languageDictionary
. Cette option ne prendra effet que pour les utilisateurs s’inscrivant avec des connexions à la base de données. La valeur par défaut est false.
mustAcceptTerms: true
prefill
Permet de définir la valeur initiale des entrées courriel et/ou nom d’utilisateur. En cas d’omission, aucune valeur initiale ne sera fournie.signUpLink
Définissez l’URL à demander en cliquant sur le bouton d’inscription. Lorsqu’elle est définie sur un lien non vide, cette option forcePermettre l’inscription
à true
.
signUpLink: 'https://yoursite.com/signup'
usernameStyle
Détermine ce qui sera utilisé pour identifier l’utilisateur pour une connexion à la base de données dont l’optionrequire_username
est défini (s’il n’est pas défini, l’option usernameStyle
sera ignorée). Les valeurs possibles sont "username"
and "email"
. Par défaut, username
et email
sont autorisés; la définition de cette option limitera les connexions à utiliser l’un ou l’autre.
usernameStyle: 'username'
Options Entreprise
defaultEnterpriseConnection
Spécifie la connexion d’entreprise qui permet de se connecter à l’aide d’un nom d’utilisateur et d’un mot de passe qui seront utilisés lorsqu’il y en a plusieurs disponibles ou qu’il existe une connexion à une base de données. SidefaultDatabaseConnection
est fourni, la connexion à la base de données sera utilisée et cette option sera ignorée.
defaultEnterpriseConnection: 'test-database'
defaultADUsernameFromEmailPrefix
Résolvez le nom d’utilisateur de l’espace réservé AD à partir du préfixe du courriel. Par défaut survrai
.
defaultADUsernameFromEmailPrefix: false
Options sans mot de passe
passwordlessMethod
Lorsque vous utilisezAuth0LockPasswordless
avec une connexion de messagerie, vous pouvez utiliser cette option pour choisir entre l’envoi d’un code ou d’un lien magique pour authentifier l’utilisateur. Les valeurs disponibles pour les connexions de messagerie sont code
et lien
. Par défaut à code
. Les connexions SMS sans mot de passe utiliseront toujours code
.
passwordlessMethod: code
Autres options
configurationBaseUrl
Remplace l’URL de base des paramètres de l’application. Par défaut, utilise le domaine fourni. Cette option n’est nécessaire que si votre cas d’utilisation spécifique exige que votre application n’utilise pas le comportement par défaut.configurationBaseUrl: "https://www.example.com"
languageBaseUrl
Remplace l’URL source de la langue pour les traductions fournies par Auth0. Par défaut, cette option utilise l’URLhttps://cdn.auth0.com
CDN d’Auth0 puisque c’est là que sont stockées toutes les traductions fournies. En fournissant une autre valeur, vous pouvez utiliser une autre source pour les traductions si nécessaire.
languageBaseUrl: "https://www.example.com"
hashCleanup
Lorsque l’optionhashCleanup
est activée, elle supprimera la partie hachage de l’URL de rappel après l’authentification de l’utilisateur. La valeur par défaut est true.
hashCleanup: false
connectionResolver
Lorsqu’il est utilisé, fournit un point d’extensibilité pour permettre de choisir la connexion à utiliser en fonction des informations du nom d’utilisateur. Possède les paramètresusername
, context
, et callback
. Le rappel attend un objet comme : {type: 'database', name: 'connection name'}
. Cela ne fonctionne que pour les connexions à la base de données. Gardez à l’esprit que ce résolveur s’exécutera dans l’événement onSubmit
du formulaire, alors restez simple et rapide.
Il s’agit d’une fonctionnalité bêta. Si vous trouvez un bogue, veuillez le signaler via une issue sur GitHub.
leeway
L’optionleeway
peut être définie sur un nombre entier - une valeur en secondes - qui peut être utilisée pour tenir compte du décalage d’horloge dans les expirations des jetons d’ID. Généralement, la valeur ne dépasse pas une minute ou deux au maximum.
leeway: 30