Skip to main content
Vous pouvez utiliser les options ci-dessous pour configurer les fonctionnalités et l’apparence de Lock pour Android. Les options de configuration sont ajoutées au générateur Lock selon le format suivant :
val lock = Lock.newBuilder(account, callback)
    // Options de configuration
    .closable(true)
    .allowSignUp(false)
    .setPrivacyURL('http://example.com/privacy')
    .setTermsURL('http://example.com/terms')
    // Fin des options de configuration
    .build(this)

Options générales

  • closable(boolean) : Indique si LockActivity peut être fermé. Par défaut, ce n’est pas possible.
  • allowedConnections(List) : Filtre les connexions autorisées à partir de la liste configurée dans le Dashboard. Par défaut, si cette valeur est vide, toutes les connexions définies dans le Dashboard sont disponibles.
  • hideMainScreenTitle(boolean) : Si cette option est définie sur true, l’en-tête de l’écran principal n’affiche pas le titre.

Options d’authentification

  • withAuthenticationParameters(Map<String, Object>) : Définit des paramètres d’authentification supplémentaires à envoyer avec chaque appel de connexion et d’inscription. Le scope par défaut utilisé pour les appels d’authentification est openid. Si vous souhaitez en préciser un autre, utilisez withAuthenticationParameters et ajoutez une autre valeur pour la clé scope.
  • withScope(String) : Modifie le scope demandé lors d’une requête d’authentification.
  • withAudience(String) : Modifie l’ demandée lors d’une requête d’authentification.

Options de la base de données

  • withUsernameStyle(int): Définit s’il faut demander uniquement le courriel, uniquement le nom d’utilisateur, ou les deux. Les valeurs acceptées sont USERNAME et EMAIL. Par défaut, cette option respecte la configuration du Dashboard pour le paramètre requires_username.
  • loginAfterSignUp(boolean): Indique si, après un événement SignUp, l’utilisateur doit être connecté automatiquement. La valeur par défaut est true.
  • initialScreen(int): Permet de personnaliser le formulaire qui s’affichera en premier au lancement de Lock. Les valeurs acceptées sont LOG_IN, SIGN_UP et FORGOT_PASSWORD. Par défaut, LOG_IN est l’écran initial.
  • allowSignUp(boolean): Affiche le formulaire d’inscription si une connexion de base de données est configurée et autorisée dans le Dashboard. La valeur par défaut est true.
  • allowLogIn(boolean): Affiche le formulaire de connexion si une connexion de base de données est configurée. La valeur par défaut est true.
  • allowForgotPassword(boolean): Affiche le formulaire de mot de passe oublié si une connexion de base de données est configurée et autorisée dans le Dashboard. La valeur par défaut est true.
  • allowShowPassword(boolean): Affiche un bouton permettant d’afficher ou de masquer le contenu d’un champ de mot de passe. La valeur par défaut est true.
  • setDefaultDatabaseConnection(String): Définit la connexion de base de données par défaut. Cette option est utile si votre application a plusieurs connexions de base de données configurées.
  • enableEnterpriseWebAuthenticationFor(List): Filtre les connexions d’entreprise qui lanceront un flux d’authentification Web dans le navigateur lorsqu’elles sont sélectionnées. Seules les stratégies ‘ad’, ‘adfs’ ou ‘waad’ sont autorisées.
  • withSignUpFields(List): Affiche un deuxième écran avec des champs supplémentaires à remplir après avoir saisi le nom d’utilisateur ou le courriel ainsi que le mot de passe dans l’écran d’inscription. Les valeurs soumises de cette façon peuvent être stockées dans le profil de l’utilisateur à l’aide d’un attribut racine ou de l’attribut user_metadata. Pour en savoir plus, consultez Lock Android: Champs personnalisés à l’inscription.
  • setPrivacyURL(String): Permet de personnaliser l’URL de la politique de confidentialité. La valeur par défaut est https://auth0.com/privacy.
  • setTermsURL(String): Permet de personnaliser l’URL des conditions d’utilisation. La valeur par défaut est https://auth0.com/terms.
  • setSupportURL(String): Permet de définir une URL d’assistance qui sera affichée si une erreur non récupérable survient dans Lock.
  • setMustAcceptTerms(boolean): Oblige l’utilisateur à accepter les conditions d’utilisation et la politique avant de s’inscrire. La valeur par défaut est false.
  • useLabeledSubmitButton(boolean): Si cette option est définie à true, le bouton de soumission affichera un libellé correspondant au mode actuel (inscription/connexion) au lieu d’une icône. La valeur par défaut est true. Si l’option hideMainScreenTitle est définie à true, ce paramètre est ignoré et un libellé sera quand même utilisé.

Options OAuth

  • withAuthStyle(String, int): Personnalisez l’apparence d’une connexion donnée (nom) à l’aide d’un style précis. Consultez ce document sur les connexions OAuth personnalisées pour en savoir plus.
  • withConnectionScope(String, String…): Permet de spécifier des scopes supplémentaires pour un nom de connexion donné, qui seront demandés avec ceux définis dans les paramètres de la connexion dans Auth0 Dashboard. Les scopes ne sont validés d’aucune manière et doivent être reconnus par le fournisseur d’authentification indiqué. Pour en voir la liste, consultez Auth0 Dashboard dans les paramètres de la connexion en question.
  • withScheme(String): Permet de modifier le schéma du redirect_uri envoyé lors de l’appel d’autorisation. Par défaut, le schéma est https. Si ce paramètre est modifié, l’espace réservé du manifeste pour auth0Scheme ainsi que les « Allowed Callbacks URLs » dans le tableau de bord de l’application Auth0 doivent aussi être mis à jour.

Options de Passwordless

  • useCode() : Envoie un code au lieu d’un lien par courriel/SMS pour l’authentification .
  • useLink() : Envoie un lien au lieu d’un code par courriel/SMS pour l’authentification Passwordless.
  • rememberLastLogin(boolean) : Indique si le courriel ou le numéro de téléphone utilisés lors de la dernière authentification réussie seront enregistrés afin d’ouvrir automatiquement une session lors de la prochaine demande d’authentification Passwordless.