Autenticarsi utilizzando Microsoft su Android

Puoi consentire ai tuoi utenti di autenticarsi con Firebase utilizzando provider OAuth come Microsoft Azure Active Directory integrando l'accesso OAuth generico basato sul Web nella tua app utilizzando l'SDK di Firebase per eseguire il flusso di accesso end-to-end.

Prima di iniziare

Per accedere agli utenti utilizzando account Microsoft (Azure Active Directory e account Microsoft personali), devi prima abilitare Microsoft come provider di accesso per il tuo progetto Firebase:

  1. Aggiungi Firebase al tuo progetto Android .

  2. Nella console Firebase , apri la sezione Autenticazione .
  3. Nella scheda Metodo di accesso abilitare il provider Microsoft .
  4. Aggiungi l' ID client e il segreto client dalla console per sviluppatori di quel provider alla configurazione del provider:
    1. Per registrare un client Microsoft OAuth, seguire le istruzioni in Avvio rapido: registrare un'app con l'endpoint Azure Active Directory v2.0 . Tieni presente che questo endpoint supporta l'accesso tramite account personali Microsoft e account Azure Active Directory. Ulteriori informazioni su Azure Active Directory v2.0.
    2. Quando registri app con questi provider, assicurati di registrare il dominio *.firebaseapp.com per il tuo progetto come dominio di reindirizzamento per la tua app.
  5. Fare clic su Salva .
  6. Se non hai ancora specificato l'impronta digitale SHA-1 della tua app, fallo dalla pagina Impostazioni della console Firebase. Fai riferimento a Autenticazione del tuo client per i dettagli su come ottenere l'impronta digitale SHA-1 della tua app.

Gestisci il flusso di accesso con l'SDK Firebase

Se stai creando un'app Android, il modo più semplice per autenticare i tuoi utenti con Firebase utilizzando i loro account Microsoft è gestire l'intero flusso di accesso con Firebase Android SDK.

Per gestire il flusso di accesso con Firebase Android SDK, procedi nel seguente modo:

  1. Costruisci un'istanza di un OAuthProvider utilizzando il relativo Builder con l'ID provider microsoft.com .

    Kotlin+KTX

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

    Java

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

  2. Facoltativo : specifica parametri OAuth personalizzati aggiuntivi che desideri inviare con la richiesta 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");

    Per i parametri supportati da Microsoft, consulta la documentazione di Microsoft OAuth . Tieni presente che non puoi passare i parametri richiesti da Firebase con setCustomParameters() . Questi parametri sono client_id , risposta_tipo , reindirizzamento_uri , stato , ambito e risposta_modalità .

    Per consentire solo agli utenti di un determinato tenant di Azure AD di accedere all'applicazione, è possibile utilizzare il nome di dominio descrittivo del tenant di Azure AD o l'identificatore GUID del tenant. Questo può essere fatto specificando il campo "tenant" nell'oggetto parametri personalizzati.

    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. Facoltativo : specifica ulteriori ambiti OAuth 2.0 oltre al profilo di base che desideri richiedere al provider di autenticazione.

    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);

    Per saperne di più, fai riferimento alla documentazione sulle autorizzazioni e consensi Microsoft .

  4. Autenticarsi con Firebase utilizzando l'oggetto provider OAuth. Tieni presente che, a differenza di altre operazioni FirebaseAuth, questo prenderà il controllo della tua interfaccia utente aprendo una scheda Chrome personalizzata . Di conseguenza, non fare riferimento alla tua attività in OnSuccessListener e OnFailureListener che colleghi poiché si scollegheranno immediatamente quando l'operazione avvia l'interfaccia utente.

    Dovresti prima controllare se hai già ricevuto una risposta. L'accesso tramite questo metodo mette la tua attività in background, il che significa che può essere recuperata dal sistema durante il flusso di accesso. Per assicurarti di non costringere l'utente a riprovare se ciò accade, dovresti controllare se è già presente un risultato.

    Per verificare se è presente un risultato in sospeso, chiama 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.
    }

    Per avviare il flusso di accesso, chiama 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.
                        }
                    });

    Una volta completato con successo, il token di accesso OAuth associato al provider può essere recuperato dall'oggetto OAuthCredential restituito.

    Utilizzando il token di accesso OAuth, puoi chiamare l' API Microsoft Graph .

    A differenza di altri provider supportati da Firebase Auth, Microsoft non fornisce un URL di foto e invece i dati binari per una foto del profilo devono essere richiesti tramite Microsoft Graph API .

    Oltre al token di accesso OAuth, è possibile recuperare anche il token ID OAuth dell'utente dall'oggetto OAuthCredential . L'attestazione sub nel token ID è specifica dell'app e non corrisponderà all'identificatore utente federato utilizzato da Firebase Auth e accessibile tramite user.getProviderData().get(0).getUid() . Al suo posto dovrebbe essere utilizzato il campo oid . Quando si usa un tenant di Azure AD per l'accesso, l'attestazione oid corrisponderà esattamente. Tuttavia, nel caso del non tenant, il campo oid è riempito. Per un ID federato 4b2eabcdefghijkl , l' oid avrà il formato 00000000-0000-0000-4b2e-abcdefghijkl .

  5. Sebbene gli esempi precedenti si concentrino sui flussi di accesso, hai anche la possibilità di collegare un provider Microsoft a un utente esistente utilizzando startActivityForLinkWithProvider . Ad esempio, puoi collegare più fornitori allo stesso utente consentendo loro di accedere con entrambi.

    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. Lo stesso modello può essere utilizzato con startActivityForReauthenticateWithProvider che può essere utilizzato per recuperare nuove credenziali per operazioni sensibili che richiedono un accesso recente.

    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.
                        }
                    });

Prossimi passi

Dopo che un utente accede per la prima volta, viene creato un nuovo account utente e collegato alle credenziali, ovvero nome utente e password, numero di telefono o informazioni sul provider di autenticazione, con cui l'utente ha effettuato l'accesso. Questo nuovo account viene archiviato come parte del tuo progetto Firebase e può essere utilizzato per identificare un utente in ogni app del tuo progetto, indipendentemente dalla modalità di accesso dell'utente.

  • Nelle tue app puoi ottenere le informazioni di base del profilo dell'utente dall'oggetto FirebaseUser . Vedi Gestisci utenti .

  • Nel tuo Firebase Realtime Database e Cloud Storage Security Rules , puoi ottenere l'ID utente univoco dell'utente che ha effettuato l'accesso dalla variabile auth e utilizzarlo per controllare a quali dati può accedere un utente.

Puoi consentire agli utenti di accedere alla tua app utilizzando più provider di autenticazione collegando le credenziali del provider di autenticazione a un account utente esistente.

Per disconnettere un utente, chiamare signOut :

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();