Save the date - Google I/O returns May 18-20. Register to get the most out of the digital experience: Build your schedule, reserve space, participate in Q&As, earn Google Developer profile badges, and more. Register now
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Ajoutez facilement une connexion à votre application Web avec FirebaseUI

FirebaseUI est une bibliothèque construite sur le SDK d'authentification Firebase qui fournit des flux d'interface utilisateur à utiliser dans votre application. FirebaseUI offre les avantages suivants:

  • Fournisseurs multiples - flux de connexion pour e-mail / mot de passe, lien e-mail, authentification par téléphone, connexion à Google, Facebook, Twitter et GitHub.
  • Liaison de compte - permet de lier en toute sécurité les comptes d'utilisateurs entre les fournisseurs d'identité.
  • Personnalisation - remplacez les styles CSS de FirebaseUI pour répondre aux exigences de votre application. De plus, comme FirebaseUI est open source, vous pouvez créer un fork du projet et le personnaliser exactement selon vos besoins.
  • Inscription en un clic et connexion automatique - intégration automatique avec inscription en un clic pour une connexion rapide entre appareils.
  • Interface utilisateur localisée - internationalisation de plus de 40 langues .
  • Mise à niveau des utilisateurs anonymes - possibilité de mettre à niveau les utilisateurs anonymes via la connexion / inscription. Pour plus d'informations, visitez la section Mise à niveau des utilisateurs anonymes .

Avant que tu commences

  1. Ajoutez l'authentification Firebase à votre application Web .

  2. Incluez FirebaseUI via l'une des options suivantes:

    1. CDN

      Incluez le script et le fichier CSS suivants dans la balise <head> de votre page, sous l'extrait d'initialisation de la console Firebase:

      <script src="https://www.gstatic.com/firebasejs/ui/4.8.0/firebase-ui-auth.js"></script>
      <link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/4.8.0/firebase-ui-auth.css" />
      
    2. Module npm

      Installez FirebaseUI et ses dépendances via npm à l'aide de la commande suivante:

      $ npm install firebaseui --save
      

      require les modules suivants dans vos fichiers source:

      var firebase = require('firebase');
      var firebaseui = require('firebaseui');
      
    3. Composant Bower

      Installez FirebaseUI et ses dépendances via Bower à l'aide de la commande suivante:

      $ bower install firebaseui --save
      

      Incluez les fichiers requis dans votre HTML, si votre serveur HTTP sert les fichiers dans bower_components/ :

      <script src="bower_components/firebaseui/dist/firebaseui.js"></script>
      <link type="text/css" rel="stylesheet" href="bower_components/firebaseui/dist/firebaseui.css" />
      

Initialiser FirebaseUI

Après avoir importé le SDK, initialisez l'interface utilisateur d'authentification.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

Configurer les méthodes de connexion

Avant de pouvoir utiliser Firebase pour connecter des utilisateurs, vous devez activer et configurer les méthodes de connexion que vous souhaitez prendre en charge.

Adresse e-mail et mot de passe

  1. Dans la console Firebase , ouvrez la section Authentification et activez l' authentification par e-mail et par mot de passe.

  2. Ajoutez l'ID du fournisseur de messagerie à la liste des signInOptions FirebaseUI.

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        firebase.auth.EmailAuthProvider.PROVIDER_ID
      ],
      // Other config options...
    });
    
  3. Facultatif : EmailAuthProvider peut être configuré pour demander à l'utilisateur de saisir un nom d'affichage (par défaut, true ).

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
          requireDisplayName: false
        }
      ]
    });
    
  1. Dans la console Firebase , ouvrez la section Authentification . Dans l'onglet Méthode de connexion, activez le fournisseur Email / Mot de passe . Notez que la connexion par e-mail / mot de passe doit être activée pour utiliser la connexion par lien de messagerie.

  2. Dans la même section, activez la méthode de connexion par lien par e-mail (connexion sans mot de passe) et cliquez sur Enregistrer .

  3. Ajoutez l'ID du fournisseur de messagerie à la liste des signInOptions FirebaseUI avec le lien de messagerie signInMethod .

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
          signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD
        }
      ],
      // Other config options...
    });
    
  4. Lors du rendu conditionnel de l'interface utilisateur de connexion (pertinent pour les applications à page unique), utilisez ui.isPendingRedirect() pour détecter si l'URL correspond à une connexion avec un lien de courrier électronique et si l'interface utilisateur doit être rendue pour terminer la connexion.

    // Is there an email link sign-in?
    if (ui.isPendingRedirect()) {
      ui.start('#firebaseui-auth-container', uiConfig);
    }
    // This can also be done via:
    if (firebase.auth().isSignInWithEmailLink(window.location.href)) {
      ui.start('#firebaseui-auth-container', uiConfig);
    }
    
  5. Facultatif : le EmailAuthProvider pour la connexion par lien de messagerie peut être configuré pour autoriser ou empêcher l'utilisateur de se connecter entre appareils.

    Un rappel optionnel emailLinkSignIn peut être défini pour renvoyer la configuration firebase.auth.ActionCodeSettings à utiliser lors de l'envoi du lien. Cela permet de spécifier comment le lien peut être géré, un lien dynamique personnalisé, un état supplémentaire dans le lien profond, etc. Lorsqu'elle n'est pas fournie, l'URL actuelle est utilisée et un flux Web uniquement est déclenché.

    La connexion par lien de messagerie dans FirebaseUI-web est compatible avec FirebaseUI-Android et FirebaseUI-iOS où un utilisateur démarrant le flux depuis FirebaseUI-Android peut ouvrir le lien et se connecter avec FirebaseUI-web. La même chose est vraie pour le flux opposé.

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
          signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD,
          // Allow the user the ability to complete sign-in cross device,
          // including the mobile apps specified in the ActionCodeSettings
          // object below.
          forceSameDevice: false,
          // Used to define the optional firebase.auth.ActionCodeSettings if
          // additional state needs to be passed along request and whether to open
          // the link in a mobile app if it is installed.
          emailLinkSignIn: function() {
            return {
              // Additional state showPromo=1234 can be retrieved from URL on
              // sign-in completion in signInSuccess callback by checking
              // window.location.href.
              url: 'https://www.example.com/completeSignIn?showPromo=1234',
              // Custom FDL domain.
              dynamicLinkDomain: 'example.page.link',
              // Always true for email link sign-in.
              handleCodeInApp: true,
              // Whether to handle link in iOS app if installed.
              iOS: {
                bundleId: 'com.example.ios'
              },
              // Whether to handle link in Android app if opened in an Android
              // device.
              android: {
                packageName: 'com.example.android',
                installApp: true,
                minimumVersion: '12'
              }
            };
          }
        }
      ]
    });
    

Fournisseurs OAuth (Google, Facebook, Twitter et GitHub)

  1. Dans la console Firebase , ouvrez la section Authentification et activez la connexion au fournisseur OAuth spécifiée. Assurez-vous que l'ID client et le secret OAuth correspondants sont également spécifiés.

  2. Toujours dans la section Authentification , assurez-vous que le domaine dans lequel votre page de connexion sera affichée est également ajouté à la liste des domaines autorisés.

  3. Ajoutez l'ID du fournisseur OAuth à la liste des signInOptions FirebaseUI.

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        // List of OAuth providers supported.
        firebase.auth.GoogleAuthProvider.PROVIDER_ID,
        firebase.auth.FacebookAuthProvider.PROVIDER_ID,
        firebase.auth.TwitterAuthProvider.PROVIDER_ID,
        firebase.auth.GithubAuthProvider.PROVIDER_ID
      ],
      // Other config options...
    });
    
  4. Facultatif : pour spécifier des étendues personnalisées ou des paramètres OAuth personnalisés par fournisseur, vous pouvez transmettre un objet au lieu de la valeur du fournisseur uniquement:

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.GoogleAuthProvider.PROVIDER_ID,
          scopes: [
            'https://www.googleapis.com/auth/contacts.readonly'
          ],
          customParameters: {
            // Forces account selection even when one account
            // is available.
            prompt: 'select_account'
          }
        },
        {
          provider: firebase.auth.FacebookAuthProvider.PROVIDER_ID,
          scopes: [
            'public_profile',
            'email',
            'user_likes',
            'user_friends'
          ],
          customParameters: {
            // Forces password re-entry.
            auth_type: 'reauthenticate'
          }
        },
        firebase.auth.TwitterAuthProvider.PROVIDER_ID, // Twitter does not support scopes.
        firebase.auth.EmailAuthProvider.PROVIDER_ID // Other providers don't need to be given as object.
      ]
    });
    

Numéro de téléphone

  1. Dans la console Firebase , ouvrez la section Authentification et activez la connexion par numéro de téléphone.

  2. Assurez-vous que le domaine dans lequel votre page de connexion sera affichée est également ajouté à la liste des domaines autorisés.

  3. Ajoutez l'ID du fournisseur de numéro de téléphone à la liste des signInOptions FirebaseUI.

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        firebase.auth.PhoneAuthProvider.PROVIDER_ID
      ],
      // Other config options...
    });
    
  4. Facultatif : PhoneAuthProvider peut être configuré avec des paramètres reCAPTCHA personnalisés, que reCAPTCHA soit visible ou invisible (par défaut, normal). Reportez-vous à la documentation de l'API reCAPTCHA pour plus de détails.

    Le pays par défaut à sélectionner dans l'entrée du numéro de téléphone peut également être défini. Reportez-vous à la liste des codes de pays pris en charge pour la liste complète des codes. Si non spécifié, l'entrée du numéro de téléphone sera par défaut aux États-Unis (+1).

    Les options suivantes sont actuellement prises en charge.

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.PhoneAuthProvider.PROVIDER_ID,
          recaptchaParameters: {
            type: 'image', // 'audio'
            size: 'normal', // 'invisible' or 'compact'
            badge: 'bottomleft' //' bottomright' or 'inline' applies to invisible.
          },
          defaultCountry: 'GB', // Set default country to the United Kingdom (+44).
          // For prefilling the national number, set defaultNationNumber.
          // This will only be observed if only phone Auth provider is used since
          // for multiple providers, the NASCAR screen will always render first
          // with a 'sign in with phone number' button.
          defaultNationalNumber: '1234567890',
          // You can also pass the full phone number string instead of the
          // 'defaultCountry' and 'defaultNationalNumber'. However, in this case,
          // the first country ID that matches the country code will be used to
          // populate the country selector. So for countries that share the same
          // country code, the selected country may not be the expected one.
          // In that case, pass the 'defaultCountry' instead to ensure the exact
          // country is selected. The 'defaultCountry' and 'defaultNationaNumber'
          // will always have higher priority than 'loginHint' which will be ignored
          // in their favor. In this case, the default country will be 'GB' even
          // though 'loginHint' specified the country code as '+1'.
          loginHint: '+11234567890'
        }
      ]
    });
    

S'identifier

Pour lancer le flux de connexion FirebaseUI, initialisez l'instance FirebaseUI en transmettant l'instance Auth sous-jacente.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

Définissez l'élément HTML dans lequel le widget de connexion FirebaseUI sera rendu.

<!-- The surrounding HTML is left untouched by FirebaseUI.
     Your app may use that space for branding, controls and other customizations.-->
<h1>Welcome to My Awesome App</h1>
<div id="firebaseui-auth-container"></div>
<div id="loader">Loading...</div>

Spécifiez la configuration FirebaseUI (fournisseurs pris en charge et personnalisations de l'interface utilisateur, ainsi que les rappels de réussite, etc.).

var uiConfig = {
  callbacks: {
    signInSuccessWithAuthResult: function(authResult, redirectUrl) {
      // User successfully signed in.
      // Return type determines whether we continue the redirect automatically
      // or whether we leave that to developer to handle.
      return true;
    },
    uiShown: function() {
      // The widget is rendered.
      // Hide the loader.
      document.getElementById('loader').style.display = 'none';
    }
  },
  // Will use popup for IDP Providers sign-in flow instead of the default, redirect.
  signInFlow: 'popup',
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    // Leave the lines as is for the providers you want to offer your users.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Terms of service url.
  tosUrl: '<your-tos-url>',
  // Privacy policy url.
  privacyPolicyUrl: '<your-privacy-policy-url>'
};

Enfin, affichez l'interface FirebaseUI Auth:

// The start method will wait until the DOM is loaded.
ui.start('#firebaseui-auth-container', uiConfig);

Mise à niveau des utilisateurs anonymes

Activation de la mise à niveau des utilisateurs anonymes

Lorsqu'un utilisateur anonyme se connecte ou s'inscrit avec un compte permanent, vous voulez être sûr qu'il peut continuer ce qu'il faisait avant de s'inscrire. Pour ce faire, définissez simplement autoUpgradeAnonymousUsers sur true lorsque vous configurez l'interface utilisateur de connexion (cette option est désactivée par défaut).

Gestion des conflits de fusion de mise à niveau d'utilisateurs anonymes

Il existe des cas où un utilisateur, initialement connecté de manière anonyme, tente de passer à un utilisateur Firebase existant. Puisqu'un utilisateur existant ne peut pas être lié à un autre utilisateur existant, FirebaseUI déclenchera le rappel signInFailure avec un code d'erreur firebaseui/anonymous-upgrade-merge-conflict lorsque ce qui précède se produit. L'objet d'erreur contiendra également les informations d'identification permanentes. La connexion avec les informations d'identification permanentes doit être déclenchée dans le rappel pour terminer la connexion. Avant de pouvoir vous auth.signInWithCredential(error.credential) via auth.signInWithCredential(error.credential) , vous devez enregistrer les données de l'utilisateur anonyme et supprimer l'utilisateur anonyme. Ensuite, une fois la connexion terminée, recopiez les données vers l'utilisateur non anonyme. Un exemple ci-dessous illustre le fonctionnement de ce flux.

// Temp variable to hold the anonymous user data if needed.
var data = null;
// Hold a reference to the anonymous current user.
var anonymousUser = firebase.auth().currentUser;
ui.start('#firebaseui-auth-container', {
  // Whether to upgrade anonymous users should be explicitly provided.
  // The user must already be signed in anonymously before FirebaseUI is
  // rendered.
  autoUpgradeAnonymousUsers: true,
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  callbacks: {
    // signInFailure callback must be provided to handle merge conflicts which
    // occur when an existing credential is linked to an anonymous user.
    signInFailure: function(error) {
      // For merge conflicts, the error.code will be
      // 'firebaseui/anonymous-upgrade-merge-conflict'.
      if (error.code != 'firebaseui/anonymous-upgrade-merge-conflict') {
        return Promise.resolve();
      }
      // The credential the user tried to sign in with.
      var cred = error.credential;
      // Copy data from anonymous user to permanent user and delete anonymous
      // user.
      // ...
      // Finish sign-in after data is copied.
      return firebase.auth().signInWithCredential(cred);
    }
  }
});

Prochaines étapes

  • Pour plus d'informations sur l'utilisation et la personnalisation de FirebaseUI, visitez le README .
  • Si vous trouvez un problème dans FirebaseUI et que vous souhaitez le signaler, utilisez l' outil de suivi des problèmes GitHub .