Authentifier à l'aide de Microsoft sur Android

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.

Avant que tu commences

Pour connecter des utilisateurs à l'aide de comptes Microsoft (Azure Active Directory et comptes Microsoft personnels), vous devez d'abord activer Microsoft en tant que fournisseur de connexion pour votre projet Firebase :

  1. Ajoutez Firebase à votre projet Android .

  2. Dans la console Firebase , ouvrez la section Auth .
  3. Sous l’onglet Méthode de connexion , activez le fournisseur Microsoft .
  4. Ajoutez l' ID client et le secret client de la console de développement de ce fournisseur à la configuration du fournisseur :
    1. Pour enregistrer un client Microsoft OAuth, suivez les instructions dans Démarrage rapide : Enregistrer une application auprès du point de terminaison Azure Active Directory v2.0 . Notez que ce point de terminaison prend en charge la connexion à l’aide de comptes personnels Microsoft ainsi que de comptes Azure Active Directory. En savoir plus sur Azure Active Directory v2.0.
    2. Lorsque vous enregistrez des applications auprès de ces fournisseurs, assurez-vous d'enregistrer le domaine *.firebaseapp.com pour votre projet en tant que domaine de redirection pour votre application.
  5. Cliquez sur Enregistrer .
  6. Si vous n'avez pas encore spécifié l'empreinte digitale SHA-1 de votre application, faites-le depuis la page Paramètres de la console Firebase. Reportez-vous à Authentification de votre client pour plus de détails sur la façon d'obtenir l'empreinte digitale SHA-1 de votre application.

Gérer le flux de connexion avec le SDK Firebase

Si vous créez une application Android, le moyen le plus simple d'authentifier vos utilisateurs auprès de Firebase à l'aide de leurs comptes Microsoft consiste à gérer l'intégralité du flux de connexion avec le SDK Android Firebase.

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

  1. Construisez une instance d'un OAuthProvider à l'aide de son générateur avec l'ID de fournisseur microsoft.com .

    Kotlin+KTX

    val provider = OAuthProvider.newBuilder("microsoft.com")

    Java

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("microsoft.com");

  2. Facultatif : Spécifiez les paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.

    Kotlin+KTX

    // Target specific email with login hint.
    // Force re-consent.
    provider.addCustomParameter("prompt", "consent")
    
    // Target specific email with login hint.
    provider.addCustomParameter("login_hint", "user@firstadd.onmicrosoft.com")

    Java

    // Target specific email with login hint.
    // Force re-consent.
    provider.addCustomParameter("prompt", "consent");
    
    // Target specific email with login hint.
    provider.addCustomParameter("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.

    Kotlin+KTX

    // 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".
    provider.addCustomParameter("tenant", "TENANT_ID")

    Java

    // 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".
    provider.addCustomParameter("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.

    Kotlin+KTX

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    provider.scopes = listOf("mail.read", "calendars.read")

    Java

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    List<String> scopes =
            new ArrayList<String>() {
                {
                    add("mail.read");
                    add("calendars.read");
                }
            };
    provider.setScopes(scopes);

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

  4. Authentifiez-vous auprès de Firebase à l'aide de l'objet fournisseur OAuth. Notez que contrairement aux autres opérations FirebaseAuth, cela prendra le contrôle de votre interface utilisateur en faisant apparaître un onglet Chrome personnalisé . Par conséquent, ne référencez pas votre activité dans OnSuccessListener et OnFailureListener que vous attachez car ils se détacheront immédiatement lorsque l'opération démarrera l'interface utilisateur.

    Vous devez d'abord vérifier si vous avez déjà reçu une réponse. La connexion via cette méthode place votre activité en arrière-plan, ce qui signifie qu'elle peut être récupérée par le système pendant le flux de connexion. Afin de vous assurer que vous n'obligez pas l'utilisateur à réessayer si cela se produit, vous devez vérifier si un résultat est déjà présent.

    Pour vérifier s'il y a un résultat en attente, appelez getPendingAuthResult :

    Kotlin+KTX

    val pendingResultTask = firebaseAuth.pendingAuthResult
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
            .addOnSuccessListener {
                // User is signed in.
                // IdP data available in
                // authResult.getAdditionalUserInfo().getProfile().
                // The OAuth access token can also be retrieved:
                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                // The OAuth secret can be retrieved by calling:
                // ((OAuthCredential)authResult.getCredential()).getSecret().
            }
            .addOnFailureListener {
                // Handle failure.
            }
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

    Java

    Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult();
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
                .addOnSuccessListener(
                        new OnSuccessListener<AuthResult>() {
                            @Override
                            public void onSuccess(AuthResult authResult) {
                                // User is signed in.
                                // IdP data available in
                                // authResult.getAdditionalUserInfo().getProfile().
                                // The OAuth access token can also be retrieved:
                                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                                // The OAuth secret can be retrieved by calling:
                                // ((OAuthCredential)authResult.getCredential()).getSecret().
                            }
                        })
                .addOnFailureListener(
                        new OnFailureListener() {
                            @Override
                            public void onFailure(@NonNull Exception e) {
                                // Handle failure.
                            }
                        });
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

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

    Kotlin+KTX

    firebaseAuth
        .startActivityForSignInWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // User is signed in.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // ((OAuthCredential)authResult.getCredential()).getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    firebaseAuth
            .startActivityForSignInWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is signed in.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // ((OAuthCredential)authResult.getCredential()).getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

    En cas de réussite, le jeton d'accès OAuth associé au fournisseur peut être récupéré à partir de l'objet OAuthCredential renvoyé.

    À 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 .

    Outre le jeton d'accès OAuth, le jeton d'identification OAuth de l'utilisateur peut également être récupéré à partir de l'objet OAuthCredential . La sub revendication dans le jeton d'ID est spécifique à l'application et ne correspondra pas à l'identifiant d'utilisateur fédéré utilisé par Firebase Auth et accessible via user.getProviderData().get(0).getUid() . Le champ de réclamation oid doit être utilisé à la place. Lorsque vous utilisez un locataire Azure AD pour vous connecter, la revendication oid correspondra exactement. Cependant, pour le cas non-locataire, le champ oid est complété. Pour un ID fédéré 4b2eabcdefghijkl , l' oid aura la forme 00000000-0000-0000-4b2e-abcdefghijkl .

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

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForLinkWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // Provider credential is linked to the current user.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // authResult.getCredential().getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // authResult.getCredential().getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForLinkWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // Provider credential is linked to the current user.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // authResult.getCredential().getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // authResult.getCredential().getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

  6. Le même modèle peut être utilisé avec startActivityForReauthenticateWithProvider qui peut être utilisé pour récupérer de nouvelles informations d'identification pour les opérations sensibles nécessitant une connexion récente.

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForReauthenticateWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // User is re-authenticated with fresh tokens and
            // should be able to perform sensitive operations
            // like account deletion and email or password
            // update.
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is re-authenticated with fresh tokens and
                            // should be able to perform sensitive operations
                            // like account deletion and email or password
                            // update.
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

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 FirebaseUser . Voir Gérer les utilisateurs .

  • 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 :

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();