Lock.Android: Configuration

Vous pouvez utiliser les options ci-dessous pour configurer les fonctions et l’apparence de Lock pour Android.

Les options de configuration sont ajoutées au Lock Builder en utilisant le format suivant :

val lock = Lock.newBuilder(account, callback)
    // Configuration options
    .closable(true)
    .allowSignUp(false)
    .setPrivacyURL('http://example.com/privacy')
    .setTermsURL('http://example.com/terms')
    // End configuration options
    .build(this)

Was this helpful?

/

Options générales

  • closable(boolean): Defines if the LockActivity can be closed. By default, it’s not closable.

  • 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 seront prises en compte.

  • hideMainScreenTitle(boolean): If set to true, the header on the main screen won’t display the title.

Options d’authentification

  • withAuthenticationParameters(Map<String, Object>): définit les paramètres d’authentification supplémentaires à envoyer lors de chaque appel de connexion et d’inscription. La scope par défaut utilisée pour les appels d’authentification est openid. Si vous voulez en utiliser une autre, choisissez withAuthenticationParameters et ajoutez une valeur différente pour la clé scope.

  • withScope(String): modifie la permission demandée lors d’une demande d’authentification.

  • withAudience(String): modifie le public demandé lors d’une demande d’authentification.

Options de base de données

  • withUsernameStyle(int): définit si on doit seulement demander l’adresse de courriel, le nom d’utilisateur, ou les deux. Les valeurs acceptés sont USERNAME et EMAIL. La configuration du paramètre requires_username du Dashboard est respectée par défaut.

  • loginAfterSignUp(boolean): définit 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 sera affiché en premier au lancement de Lock. Les valeurs acceptés sont LOG_IN, SIGN_UP, et FORGOT_PASSWORD. Par défaut, l’écran initial est LOG_IN.

  • allowSignUp(boolean): Shows the signup form if a Database connection is configured and it’s allowed from the Dashboard. Defaults to true.

  • allowLogIn(boolean): affiche le formulaire de connexion si une connexion par base de données est configurée. La valeur par défaut est true.

  • allowForgotPassword(boolean): This shows the Forgot Password form if a Database connection is configured and it’s allowed from the Dashboard. Defaults to true.

  • allowShowPassword(boolean): affiche un bouton permettant d’activer/désactiver la visibilité de la saisie d’un champ Mot de passe. La valeur par défaut est true.

  • setDefaultDatabaseConnection(String): définit la connexion par base de données par défaut. Cela est utile si votre application a plusieurs connexions par base de données configurées.

  • enableEnterpriseWebAuthenticationFor(List): filtre les connexions d’entreprise qui déclencheront une authentification Web à partir du navigateur lorsqu’elles seront sélectionnées. Seules les stratégies ’ad’, ’adfs’, ou ’waad’ sont autorisées.

  • withSignUpFields(List): affiche un deuxième écran contenant des champs supplémentaires à remplir par l’utilisateur après que le nom d’utilisateur/l’adresse courriel et le mot de passe ont été saisis dans l’écran d’inscription. Les valeurs soumises de cette manière peuvent être stockées dans le profil 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 de service. La valeur par défaut est https://auth0.com/terms.

  • setSupportURL(String): permet de définir une URL d’assistance qui sera affichée au cas où une erreur non récupérable survient dans Lock.

  • setMustAcceptTerms(boolean): oblige l’utilisateur à accepter les Conditions d’utilisation avant de s’inscrire. La valeur par défaut est false.

  • useLabeledSubmitButton(boolean): si elle est définie sur true, elle affichera une étiquette indiquant le mode actuel (inscription/connexion) dans le bouton d’envoi au lieu d’une icône. La valeur par défaut est true. Si l’option hideMainScreenTitle est définie sur ‘true’, ce paramètre est ignoré et une étiquette sera utilisée de toute façon.

OAuth options

  • withAuthStyle(String, int): personnalise l’apparence d’une connexion donnée (nom) avec un style particulier. Consultez ce document sur les connexions OAuth personnalisées pour en savoir plus.

  • withConnectionScope(String, String...): permet d’indiquer des permissions supplémentaires pour un nom de connexion donné, qui seront demandées en même temps que celles définies dans les paramètres de connexion dans Auth0 Dashboard. Les permissions ne sont en aucun cas validées et doivent être reconnues par le fournisseur d’authentification donné. Pour obtenir la liste, cochez Auth0 Dashboard dans les paramètres de la connexion concernée.

  • withScheme(String) : permet de changer la schéma du redirect_uri envoyé lors de l’appel authorize. Par défaut, le schéma est https. Si ce paramètre est modifié, le placeholder du manifeste auth0Scheme et les callback URL autorisées dans le tableau de bord de l’application Auth0 doivent également être mises à jour.

Options Sans mot de passe

  • useCode(): envoyer un code au lieu d’un lien par courriel/SMS pour l’authentification sans mot de passe.

  • useLink(): envoyer un lien au lieu d’un code par courriel/SMS pour l’authentification sans mot de passe.

  • rememberLastLogin(boolean): indique si l’adresse courriel ou le numéro de téléphone utilisés lors de la dernière authentification réussie seront enregistrés pour la connexion automatique lors de la prochaine demande d’authentification sans mot de passe.