Authentifier à l'aide de Microsoft et Unity

Vous pouvez permettre à vos utilisateurs de s'authentifier auprès de Firebase à l'aide de fournisseurs OAuth tels que Microsoft Azure Active Directory en intégrant la connexion OAuth générique basée sur le Web dans votre application à l'aide du SDK Firebase pour effectuer le flux de connexion de bout en bout. Étant donné que ce flux nécessite l'utilisation des SDK Firebase basés sur téléphone, il n'est pris en charge que sur les plates-formes Android et Apple.

Avant que tu commences

Avant de pouvoir utiliser l'authentification Firebase , vous devez :

  • Enregistrez votre projet Unity et configurez-le pour utiliser Firebase.

    • Si votre projet Unity utilise déjà Firebase, il est déjà enregistré et configuré pour Firebase.

    • Si vous n'avez pas de projet Unity, vous pouvez télécharger un exemple d'application .

  • Ajoutez le SDK Firebase Unity (en particulier FirebaseAuth.unitypackage ) à votre projet Unity.

Notez que l'ajout de Firebase à votre projet Unity implique des tâches à la fois dans la console Firebase et dans votre projet Unity ouvert (par exemple, vous téléchargez les fichiers de configuration Firebase depuis la console, puis vous les déplacez dans votre projet Unity).

Accéder à la classe Firebase.Auth.FirebaseAuth

La classe FirebaseAuth est la passerelle pour tous les appels d'API. Il est accessible via FirebaseAuth.DefaultInstance .
Firebase.Auth.FirebaseAuth auth = Firebase.Auth.FirebaseAuth.DefaultInstance;

Gérer le flux de connexion avec le SDK Firebase

Pour gérer le flux de connexion avec le SDK Firebase, procédez comme suit :

  1. Construisez une instance de FederatedOAuthProviderData configurée avec l’ID de fournisseur approprié pour Microsoft.

    Firebase.Auth.FederatedOAuthProviderData providerData =
      new Firebase.Auth.FederatedOAuthProviderData();
    providerData.ProviderId = Firebase.Auth.MicrosoftAuthProvider.ProviderId;
    
  2. Facultatif : Spécifiez les paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.

    providerData.CustomParameters = new Dictionary<string,string>;
    
    // Prompt user to re-authenticate to Microsoft.
    providerData.CustomParameters.Add("prompt", "login");
    
    // Target specific email with login hint.
    providerData.CustomParameters.Add("login_hint",
        "user@firstadd.onmicrosoft.com");
    

    Pour les paramètres pris en charge par Microsoft, consultez la documentation Microsoft OAuth . Notez que vous ne pouvez pas transmettre les paramètres requis par Firebase avec setCustomParameters() . Ces paramètres sont client_id , Response_type , redirect_uri , State , Scope et Response_mode .

    Pour autoriser uniquement les utilisateurs d'un locataire Azure AD particulier à se connecter à l'application, vous pouvez utiliser soit le nom de domaine convivial du locataire Azure AD, soit l'identifiant GUID du locataire. Cela peut être fait en spécifiant le champ « locataire » dans l'objet de paramètres personnalisés.

    // Optional "tenant" parameter in case you are using an Azure AD tenant.
    // eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or 'contoso.onmicrosoft.com'
    // or "common" for tenant-independent tokens.
    // The default value is "common".
    providerData.CustomParameters.Add("tenant", "TENANT_ID");
    
  3. Facultatif : Spécifiez des étendues OAuth 2.0 supplémentaires au-delà du profil de base que vous souhaitez demander au fournisseur d'authentification.

    providerData.Scopes = new List<string>();
    providerData.Scopes.Add("mail.read");
    providerData.Scopes.Add("calendars.read");
    

    Pour en savoir plus, reportez-vous à la documentation sur les autorisations et le consentement de Microsoft .

  4. Une fois les données de votre fournisseur configurées, utilisez-les pour créer un FederatedOAuthProvider.

    // Construct a FederatedOAuthProvider for use in Auth methods.
    Firebase.Auth.FederatedOAuthProvider provider = new Firebase.Auth.FederatedOAuthProvider();
    provider.SetProviderData(providerData);
    
  5. Authentifiez-vous auprès de Firebase à l'aide de l'objet fournisseur d'authentification. Notez que contrairement aux autres opérations FirebaseAuth, cela prendra le contrôle de votre interface utilisateur en faisant apparaître une vue Web dans laquelle l'utilisateur peut saisir ses informations d'identification.

    Pour démarrer le flux de connexion, appelez SignInAndRetrieveDataWithCredentialAsync :

    auth.SignInWithProviderAsync(provider).ContinueOnMainThread(task => {
        if (task.IsCanceled) {
            Debug.LogError("SignInWithProviderAsync was canceled.");
            return;
        }
        if (task.IsFaulted) {
            Debug.LogError("SignInWithProviderAsync encountered an error: " +
              task.Exception);
            return;
        }
    
        Firebase.Auth.AuthResult authResult = task.Result;
        Firebase.Auth.FirebaseUser user = authResult.User;
        Debug.LogFormat("User signed in successfully: {0} ({1})",
            user.DisplayName, user.UserId);
    });
    

    À l'aide du jeton d'accès OAuth, vous pouvez appeler l' API Microsoft Graph .

    Contrairement à d'autres fournisseurs pris en charge par Firebase Auth, Microsoft ne fournit pas d'URL de photo et, à la place, les données binaires d'une photo de profil doivent être demandées via l'API Microsoft Graph .

  6. Bien que les exemples ci-dessus se concentrent sur les flux de connexion, vous avez également la possibilité de lier un fournisseur Microsoft Azure Active Directory à un utilisateur existant à l'aide de LinkWithProviderAsync . Par exemple, vous pouvez associer plusieurs fournisseurs au même utilisateur, leur permettant de se connecter avec l'un ou l'autre.

    user.LinkWithProviderAsync(provider).ContinueOnMainThread(task => {
        if (task.IsCanceled) {
            Debug.LogError("LinkWithProviderAsync was canceled.");
            return;
        }
        if (task.IsFaulted) {
            Debug.LogError("LinkWithProviderAsync encountered an error: "
              + task.Exception);
            return;
        }
    
        Firebase.Auth.AuthResult authResult = task.Result;
        Firebase.Auth.FirebaseUser user = authResult.User;
        Debug.LogFormat("User linked successfully: {0} ({1})",
            user.DisplayName, user.UserId);
    });
    
  7. Le même modèle peut être utilisé avec ReauthenticateWithProviderAsync qui peut être utilisé pour récupérer de nouvelles informations d'identification pour les opérations sensibles nécessitant une connexion récente.

    user.ReauthenticateWithProviderAsync(provider).ContinueOnMainThread(task => {
        if (task.IsCanceled) {
            Debug.LogError("ReauthenticateWithProviderAsync was canceled.");
            return;
        }
        if (task.IsFaulted) {
            Debug.LogError(
            "ReauthenticateWithProviderAsync encountered an error: " +
                task.Exception);
            return;
        }
    
        Firebase.Auth.AuthResult authResult = task.Result;
        Firebase.Auth.FirebaseUser user = authResult.User;
        Debug.LogFormat("User reauthenticated successfully: {0} ({1})",
            user.DisplayName, user.UserId);
    });
    

Prochaines étapes

Après qu'un utilisateur se connecte pour la première fois, un nouveau compte utilisateur est créé et lié aux informations d'identification (c'est-à-dire le nom d'utilisateur et le mot de passe, le numéro de téléphone ou les informations du fournisseur d'authentification) avec lesquels l'utilisateur s'est connecté. Ce nouveau compte est stocké dans le cadre de votre projet Firebase et peut être utilisé pour identifier un utilisateur dans chaque application de votre projet, quelle que soit la manière dont l'utilisateur se connecte.

  • Dans vos applications, vous pouvez obtenir les informations de base du profil de l'utilisateur à partir de l'objet Firebase.Auth.FirebaseUser :

    Firebase.Auth.FirebaseUser user = auth.CurrentUser;
    if (user != null) {
      string name = user.DisplayName;
      string email = user.Email;
      System.Uri photo_url = user.PhotoUrl;
      // The user's Id, unique to the Firebase project.
      // Do NOT use this value to authenticate with your backend server, if you
      // have one; use User.TokenAsync() instead.
      string uid = user.UserId;
    }
    
  • Dans vos règles de sécurité Firebase Realtime Database et Cloud Storage, vous pouvez obtenir l'ID utilisateur unique de l'utilisateur connecté à partir de la variable auth et l'utiliser pour contrôler les données auxquelles un utilisateur peut accéder.

Vous pouvez autoriser les utilisateurs à se connecter à votre application à l'aide de plusieurs fournisseurs d'authentification en associant les informations d'identification du fournisseur d'authentification à un compte utilisateur existant.

Pour déconnecter un utilisateur, appelez SignOut() :

auth.SignOut();