Hızlı Başlangıç: Android uygulamasına Microsoft ile oturum açma ekleme - Microsoft identity platform

Hoş geldiniz! Bu muhtemelen beklediğiniz sayfa değildir. Şu anda bir düzeltme üzerinde çalışıyoruz, ancak şimdilik lütfen aşağıdaki bağlantıyı kullanın; sizi doğru makaleye götürmelidir:

Hızlı Başlangıç: Android uygulamasından kullanıcıların oturumunu açma ve Microsoft Graph'ı arama

Bu sorun için özür dileriz ve bu sorunu çözmek için çalışırken sabrınızı takdir ediyoruz.

Bu hızlı başlangıçta, bir Android uygulamasının kullanıcılarda nasıl oturum açabileceğini ve Microsoft Graph API'sini çağırmak için erişim belirteci alabileceğini gösteren bir kod örneği indirip çalıştıracaksınız.

Örneğin nasıl çalıştığını görmek için bakın.

Microsoft kimlik platformunun uygulamanıza belirteç sağlayabilmesi için uygulamalar Microsoft Entra Id'deki bir uygulama nesnesiyle temsil edilmelidir.

Önkoşullar

Aktif bir aboneliğe sahip bir Azure hesabı. Ücretsiz hesap oluşturun.
Android Stüdyosu
Android 16+ sürümü

1. Adım: Uygulamanızı Azure portalında yapılandırma

Bu hızlı başlangıçtaki kod örneğinin çalışması için Kimlik Doğrulama aracısı ile uyumlu bir Yeniden Yönlendirme URI'sini ekleyin.

Bu değişiklikleri benim için yap

Zaten yapılandırılmış Uygulamanız bu özniteliklerle yapılandırılmış

2. Adım: Projeyi indirme

Android Studio kullanarak projeyi çalıştırın.

Kod örneğini indirme

3. Adım: Uygulamanız yapılandırılmış ve çalışmaya hazır

Projenizi uygulamanızın özelliklerinin değerleriyle yapılandırdık ve çalışmaya hazır. Örnek uygulama Tek Hesap Modu ekranında başlar. Varsayılan olarak sağlanan user.read kapsamı, Microsoft Graph API çağrısı sırasında kendi profil verilerinizi okurken kullanılır. Microsoft Graph API çağrısının URL'si varsayılan olarak sağlanır. İsterseniz bunların ikisini de değiştirebilirsiniz.

Tek ve birden çok hesap kullanımını gösteren MSAL örnek uygulaması

Tek ve birden çok hesap modu arasında değişiklik yapmak için uygulama menüsünü kullanın.

Tek hesap modunda iş veya ev hesabı kullanarak oturum açın:

Kullanıcıdan kimlik bilgilerini istemek için Grafik verilerini etkileşimli olarak al'ı seçin. Ekranın alt kısmında Microsoft Graph API'sine yapılan çağrının çıkışını görürsünüz.
Oturum açtıktan sonra kullanıcıdan yeniden kimlik bilgileri istemeden Microsoft Graph API'sine çağrı yapmak için Grafik verilerini sessizce al seçin. Ekranın alt kısmında Microsoft Graph API'sine yapılan çağrının çıkışını görürsünüz.

Birden çok hesap modunda aynı adımları yineleyebilirsiniz. Ayrıca, oturum açmış hesabı kaldırabilirsiniz ve bu da bu hesabın önbelleğe alınmış belirteçlerini kaldırır.

Uyarı

Enter_the_Supported_Account_Info_Here

Örnek nasıl çalışır?

Örnek uygulamanın ekran görüntüsü

Kod, tek ve birden çok hesap MSAL uygulamasının nasıl yazıldığını gösteren parçalar halinde düzenlenmiştir. Kod dosyaları aşağıdaki gibi düzenlenir:

Dosya	Gösterir
AnaEtkinlik	Kullanıcı arabirimini yönetir
MSGraphRequestWrapper	MSAL tarafından sağlanan belirteci kullanarak Microsoft Graph API'sini çağırır
BirdenFazlaHesapModuBölümü	Çok hesaplı bir uygulama başlatır, bir kullanıcı hesabı yükler ve Microsoft Graph API'sini çağırmak üzere bir belirteç alır.
SingleAccountModeFragment	Tek hesaplı bir uygulama başlatır, bir kullanıcı hesabı yükler ve Microsoft Graph API'sini çağırmak için bir belirteç alır
Res/auth_config_multiple_account.json	Birden çok hesap yapılandırma dosyası
Res/auth_config_single_account.json	Tek hesap yapılandırma dosyası
Gradle Betikleri/build.gradle (Modül:app)	MSAL kütüphane bağımlılıkları buraya eklenmiştir.

Şimdi bu dosyalara daha ayrıntılı bir şekilde göz atacak ve her birinde MSAL'ye özgü kodu çağıracağız.

Uygulamaya MSAL ekleme

MSAL (com.microsoft.identity.client), kullanıcılarda oturum açmak ve Microsoft kimlik platformu tarafından korunan bir API'ye erişmek için kullanılan belirteçleri istemek için kullanılan kitaplıktır. Gradle 3.0+, aşağıdakileri Gradle Betikleri>build.gradle (Modül: uygulama) dosyasında Bağımlılıklar bölümüne eklediğinizde kitaplığı yükler.

dependencies {
    ...
    implementation 'com.microsoft.identity.client:msal:2.+'
    ...
}

Bu, Gradle'a maven central'dan MSAL indirmesini ve derlemesini sağlar.

Ayrıca build.gradle (Modül: uygulama) öğesinin >repositories bölümüne de maven başvuruları eklemeniz gerekir; şöyle:

allprojects {
    repositories {
        mavenCentral()
        google()
        mavenLocal()
        maven {
            url 'https://pkgs.dev.azure.com/MicrosoftDeviceSDK/DuoSDK-Public/_packaging/Duo-SDK-Feed/maven/v1'
        }
        maven {
            name "vsts-maven-adal-android"
            url "https://identitydivision.pkgs.visualstudio.com/_packaging/AndroidADAL/maven/v1"
            credentials {
                username System.getenv("ENV_VSTS_MVN_ANDROIDADAL_USERNAME") != null ? System.getenv("ENV_VSTS_MVN_ANDROIDADAL_USERNAME") : project.findProperty("vstsUsername")
                password System.getenv("ENV_VSTS_MVN_ANDROIDADAL_ACCESSTOKEN") != null ? System.getenv("ENV_VSTS_MVN_ANDROIDADAL_ACCESSTOKEN") : project.findProperty("vstsMavenAccessToken")
            }
        }
        jcenter()
    }
}

MSAL içeri aktarmaları

MSAL kitaplığı ile ilgili olan ithalatlar com.microsoft.identity.client.*. Örneğin, genel istemci uygulamanızı temsil eden sınıfın import > com.microsoft.identity.client.PublicClientApplication; ad alanının hangisi olduğunu görürsünüzPublicClientApplication.

SingleAccountModeFragment.java

Bu dosyada tek bir hesap MSAL uygulamasının nasıl oluşturulacağı ve Microsoft Graph API'sinin nasıl çağrılacağı gösterilmektedir.

Tek hesap uygulamaları yalnızca tek bir kullanıcı tarafından kullanılır. Örneğin, eşleme uygulamanızda oturum açabileceğiniz tek bir hesabınız olabilir.

Tek hesap MSAL başlatma

içindeauth_config_single_account.json, dosyasında onCreateView()depolanan PublicClientApplication yapılandırma bilgileri kullanılarak tek bir hesap auth_config_single_account.json oluşturulur. Tek hesaplı bir MSAL uygulamasında kullanılmak üzere MSAL kitaplığını bu şekilde başlatırsınız:

...
// Creates a PublicClientApplication object with res/raw/auth_config_single_account.json
PublicClientApplication.createSingleAccountPublicClientApplication(getContext(),
        R.raw.auth_config_single_account,
        new IPublicClientApplication.ISingleAccountApplicationCreatedListener() {
            @Override
            public void onCreated(ISingleAccountPublicClientApplication application) {
                /**
                 * This test app assumes that the app is only going to support one account.
                 * This requires "account_mode" : "SINGLE" in the config json file.
                 **/
                mSingleAccountApp = application;
                loadAccount();
            }

            @Override
            public void onError(MsalException exception) {
                displayError(exception);
            }
        });

içindeSingleAccountModeFragment.java, bir kullanıcının oturum açma kodu, tıklama işleyicisindedirinitializeUI()signInButton.

signIn() öğesini çağırmadan önce belirteçleri almaya çalışın. signIn() çağrılmış gibi acquireToken() davranarak kullanıcının oturum açması için etkileşimli bir istem oluşturur.

Bir kullanıcıda oturum açmak zaman uyumsuz bir işlemdir. Kullanıcı oturum açtığında Microsoft Graph API'sini çağıran ve kullanıcı arabirimini güncelleştiren bir geri arama geçirilir:

mSingleAccountApp.signIn(getActivity(), null, getScopes(), getAuthInteractiveCallback());

Kullanıcının oturumunu kapatma

içindeSingleAccountModeFragment.java, kullanıcının oturumunu kapatma kodu, tıklama işleyicisindedirinitializeUI()signOutButton. Kullanıcının oturumu kapatma işlemi zaman uyumsuz bir işlemdir. Kullanıcının oturumunu kapatması, bu hesabın belirteç önbelleğini de temizler. Kullanıcı hesabı oturumu kapatıldıktan sonra kullanıcı arabirimini güncelleştirmek için bir geri arama oluşturulur:

mSingleAccountApp.signOut(new ISingleAccountPublicClientApplication.SignOutCallback() {
    @Override
    public void onSignOut() {
        updateUI(null);
        performOperationOnSignOut();
    }

    @Override
    public void onError(@NonNull MsalException exception) {
        displayError(exception);
    }
});

Etkileşimli veya sessiz bir şekilde belirteç alma

Kullanıcıya en az sayıda istem sunmak için genellikle sessizce bir belirteç alırsınız. Ardından, bir hata varsa etkileşimli olarak belirteç almaya çalış. Uygulama signIn()'i ilk kez çağırdığında, kullanıcıdan kimlik bilgilerini isteyen bir acquireToken() çağrısı olarak işlev görür.

Kullanıcıdan hesabını seçmesi, kimlik bilgilerini girmesi veya uygulamanızın istediği izinlere onay vermesinin istenebileceği bazı durumlar şunlardır:

Kullanıcı uygulamada ilk kez oturum açtığında
Bir kullanıcı parolasını sıfırlarsa, kimlik bilgilerini girmesi gerekir
Onay iptal edilirse
Uygulamanız açıkça onay gerektiriyorsa
Uygulamanız bir kaynağa ilk kez erişim istediğinde
MFA veya diğer Koşullu Erişim ilkeleri gerektiğinde

Etkileşimli olarak bir belirteç almaya ilişkin kod( kullanıcıyı kapsayan kullanıcı arabirimiyle birlikte) içinde, içinde, tıklama işleyicisindedirSingleAccountModeFragment.javainitializeUI()callGraphApiInteractiveButton:

/**
 * If acquireTokenSilent() returns an error that requires an interaction (MsalUiRequiredException),
 * invoke acquireToken() to have the user resolve the interrupt interactively.
 *
 * Some example scenarios are
 *  - password change
 *  - the resource you're acquiring a token for has a stricter set of requirement than your Single Sign-On refresh token.
 *  - you're introducing a new scope which the user has never consented for.
 **/
mSingleAccountApp.acquireToken(getActivity(), getScopes(), getAuthInteractiveCallback());

Kullanıcı zaten oturum açtıysa, acquireTokenSilentAsync() uygulamaların tıklama işleyicisinde >initializeUI()gösterildiği gibi sessizce belirteç istemesine callGraphApiSilentButton izin verir:

/**
 * Once you've signed the user in,
 * you can perform acquireTokenSilent to obtain resources without interrupting the user.
 **/
  mSingleAccountApp.acquireTokenSilentAsync(getScopes(), AUTHORITY, getAuthSilentCallback());

Hesap yükleme

Hesap yükleme kodu içindedir SingleAccountModeFragment.javaloadAccount(). Kullanıcının hesabını yüklemek zaman uyumsuz bir işlemdir, bu nedenle hesap yüklendiğinde, değiştiğinde veya bir hata oluştuğunda işlemeye yönelik geri çağırmalar MSAL'ye geçirilir. Aşağıdaki kod, bir hesap kaldırıldığında, kullanıcı başka bir hesaba değiştiğinde vb. oluşan öğesini de işler onAccountChanged().

private void loadAccount() {
    ...

    mSingleAccountApp.getCurrentAccountAsync(new ISingleAccountPublicClientApplication.CurrentAccountCallback() {
        @Override
        public void onAccountLoaded(@Nullable IAccount activeAccount) {
            // You can use the account data to update your UI or your app database.
            updateUI(activeAccount);
        }

        @Override
        public void onAccountChanged(@Nullable IAccount priorAccount, @Nullable IAccount currentAccount) {
            if (currentAccount == null) {
                // Perform a cleanup task as the signed-in account changed.
                performOperationOnSignOut();
            }
        }

        @Override
        public void onError(@NonNull MsalException exception) {
            displayError(exception);
        }
    });

Microsoft Graph'ı arayın

Bir kullanıcı oturum açtığında, Microsoft Graph çağrısı içinde callGraphAPI()tanımlanan bir HTTP isteği SingleAccountModeFragment.java aracılığıyla yapılır. Bu işlev, authenticationResult'dan erişim belirtecini alma, MSGraphRequestWrapper'a yapılan çağrıyı paketleme ve çağrı sonuçlarının görüntülenmesi gibi bazı görevleri yerine getirerek örneği basitleştiren bir sarmalayıcıdır.

private void callGraphAPI(final IAuthenticationResult authenticationResult) {
    MSGraphRequestWrapper.callGraphAPIUsingVolley(
            getContext(),
            graphResourceTextView.getText().toString(),
            authenticationResult.getAccessToken(),
            new Response.Listener<JSONObject>() {
                @Override
                public void onResponse(JSONObject response) {
                    /* Successfully called graph, process data and send to UI */
                    ...
                }
            },
            new Response.ErrorListener() {
                @Override
                public void onErrorResponse(VolleyError error) {
                    ...
                }
            });
}

auth_config_single_account.json

Bu, tek bir hesap kullanan bir MSAL uygulamasının yapılandırma dosyasıdır.

Bu alanların açıklaması için Android MSAL yapılandırma dosyasını anlama kısmına bakın.

Bu uygulamayı tek bir hesap kullanacak şekilde yapılandıran öğesinin "account_mode" : "SINGLE"varlığına dikkat edin.

"client_id" , Microsoft'un koruduğu bir uygulama nesnesi kaydını kullanacak şekilde önceden yapılandırılmıştır. "redirect_uri", kod örneğiyle birlikte sağlanan imzalama anahtarını kullanacak şekilde önceden yapılandırılmıştır.

{
  "client_id" : "00001111-aaaa-2222-bbbb-3333cccc4444",
  "authorization_user_agent" : "DEFAULT",
  "redirect_uri" : "msauth://com.azuresamples.msalandroidapp/1wIqXSqBj7w%2Bh11ZifsnqwgyKrY%3D",
  "account_mode" : "SINGLE",
  "broker_redirect_uri_registered": true,
  "authorities" : [
    {
      "type": "AAD",
      "audience": {
        "type": "AzureADandPersonalMicrosoftAccount",
        "tenant_id": "common"
      }
    }
  ]
}

MultipleAccountModeFragment.java

Bu dosya, birden çok hesap MSAL uygulaması oluşturmayı ve Microsoft Graph API'sini çağırmayı gösterir.

Birden çok hesap uygulamasına örnek olarak, iş hesabı ve kişisel hesap gibi birden çok kullanıcı hesabıyla çalışmanızı sağlayan bir posta uygulaması örnektir.

Birden çok hesap MSAL başlatması

MultipleAccountModeFragment.java dosyasında, onCreateView() içinde depolanan yapılandırma bilgileri kullanılarak birden çok hesap uygulaması nesnesi (IMultipleAccountPublicClientApplication) oluşturulur:

// Creates a PublicClientApplication object with res/raw/auth_config_multiple_account.json
PublicClientApplication.createMultipleAccountPublicClientApplication(getContext(),
        R.raw.auth_config_multiple_account,
        new IPublicClientApplication.IMultipleAccountApplicationCreatedListener() {
            @Override
            public void onCreated(IMultipleAccountPublicClientApplication application) {
                mMultipleAccountApp = application;
                loadAccounts();
            }

            @Override
            public void onError(MsalException exception) {
                ...
            }
        });

Oluşturulan MultipleAccountPublicClientApplication nesne bir sınıf üyesi değişkeninde depolanır, böylece belirteçleri almak ve kullanıcı hesabını yükleyip kaldırmak için MSAL kitaplığıyla etkileşim kurmak için kullanılabilir.

Hesap yükleme

Çok hesaplı uygulamalar, genellikle MSAL işlemleri için kullanılacak hesabı seçmek üzere getAccounts() çağırır. Hesabı yükleme kodu MultipleAccountModeFragment.java dosyasında, loadAccounts() içindedir. Kullanıcının hesabını yüklemek zaman uyumsuz bir işlemdir. Bu nedenle, geri arama hesabın yüklendiği, değiştiği veya bir hata oluştuğu durumları işler.

/**
 * Load currently signed-in accounts, if there's any.
 **/
private void loadAccounts() {
    if (mMultipleAccountApp == null) {
        return;
    }

    mMultipleAccountApp.getAccounts(new IPublicClientApplication.LoadAccountsCallback() {
        @Override
        public void onTaskCompleted(final List<IAccount> result) {
            // You can use the account data to update your UI or your app database.
            accountList = result;
            updateUI(accountList);
        }

        @Override
        public void onError(MsalException exception) {
            displayError(exception);
        }
    });
}

Etkileşimli veya sessiz bir şekilde belirteç alma

Kullanıcıdan hesabını seçmesi, kimlik bilgilerini girmesi veya uygulamanızın istediği izinlere onay vermesinin istenebileceği bazı durumlar şunlardır:

Uygulamaya ilk kez kullanıcılar oturum açtığında
Bir kullanıcı parolasını sıfırlarsa, kimlik bilgilerini girmesi gerekir
Onay iptal edilirse
Uygulamanız açıkça onay gerektiriyorsa
Uygulamanız bir kaynağa ilk kez erişim istediğinde
MFA veya diğer Koşullu Erişim ilkeleri gerektiğinde

Birden çok hesap uygulaması genellikle kullanıcının bulunduğu kullanıcı arabiriminde ve çağrısıyla acquireToken()etkileşimli olarak belirteçler almalıdır. Etkileşimli bir token almak için kullanılan kod, MultipleAccountModeFragment.java içindeki initializeUI> () dosyasının callGraphApiInteractiveButton tıklama işleyicisindedir.

/**
 * Acquire token interactively. It will also create an account object for the silent call as a result (to be obtained by > getAccount()).
 *
 * If acquireTokenSilent() returns an error that requires an interaction,
 * invoke acquireToken() to have the user resolve the interrupt interactively.
 *
 * Some example scenarios are
 *  - password change
 *  - the resource you're acquiring a token for has a stricter set of requirement than your SSO refresh token.
 *  - you're introducing a new scope which the user has never consented for.
 **/
mMultipleAccountApp.acquireToken(getActivity(), getScopes(), getAuthInteractiveCallback());

Uygulamalar, kullanıcının her belirteç istediğinde oturum açmasını gerektirmemelidir. Kullanıcı zaten oturum açmışsa, acquireTokenSilentAsync() uygulamaların kullanıcıyı uyarmadan belirteç istemesine izin verir, MultipleAccountModeFragment.java dosyasında ve initializeUI() tıklama işleyicisinde gösterildiği gibi:

/**
 * Performs acquireToken without interrupting the user.
 *
 * This requires an account object of the account you're obtaining a token for.
 * (can be obtained via getAccount()).
 */
mMultipleAccountApp.acquireTokenSilentAsync(getScopes(),
    accountList.get(accountListSpinner.getSelectedItemPosition()),
    AUTHORITY,
    getAuthSilentCallback());

Hesabı kaldırma

Hesabı kaldırma ve hesap için önbelleğe alınmış belirteçleri kaldırma kodu, MultipleAccountModeFragment.java içindeki initializeUI() dosyasında, hesabı kaldır düğmesinin işleyicisinde bulunur. Bir hesabı kaldırabilmeniz için önce ve getAccounts()gibi acquireToken() MSAL yöntemlerinden aldığınız bir hesap nesnesine ihtiyacınız vardır. Hesabı kaldırmak zaman uyumsuz bir işlem olduğundan, onRemoved kullanıcı arabirimini güncelleştirmek için geri çağırma sağlanır.

/**
 * Removes the selected account and cached tokens from this app (or device, if the device is in shared mode).
 **/
mMultipleAccountApp.removeAccount(accountList.get(accountListSpinner.getSelectedItemPosition()),
        new IMultipleAccountPublicClientApplication.RemoveAccountCallback() {
            @Override
            public void onRemoved() {
                ...
                /* Reload account asynchronously to get the up-to-date list. */
                loadAccounts();
            }

            @Override
            public void onError(@NonNull MsalException exception) {
                displayError(exception);
            }
        });

auth_config_multiple_account.json

Bu, birden çok hesap kullanan bir MSAL uygulamasının yapılandırma dosyasıdır.

Çeşitli alanların açıklaması için Android MSAL yapılandırma dosyasını anlama başlıklı bölüme bakın.

auth_config_single_account.json yapılandırma dosyasından farklı olarak, bu yapılandırma dosyası "account_mode" : "MULTIPLE" yerine "account_mode" : "SINGLE" içerir çünkü bu, birden çok hesap uygulamasıdır.

{
  "client_id" : "00001111-aaaa-2222-bbbb-3333cccc4444",
  "authorization_user_agent" : "DEFAULT",
  "redirect_uri" : "msauth://com.azuresamples.msalandroidapp/1wIqXSqBj7w%2Bh11ZifsnqwgyKrY%3D",
  "account_mode" : "MULTIPLE",
  "broker_redirect_uri_registered": true,
  "authorities" : [
    {
      "type": "AAD",
      "audience": {
        "type": "AzureADandPersonalMicrosoftAccount",
        "tenant_id": "common"
      }
    }
  ]
}

Yardım ve destek

Yardıma ihtiyacınız varsa, bir sorunu bildirmek veya destek seçenekleriniz hakkında bilgi edinmek istiyorsanız bkz. Yardım ve geliştiriciler için destek.

Sonraki adımlar

Microsoft kimlik platformundan erişim belirteci alan ve Microsoft Graph API'sini çağırmak için bu belirteci kullanan bir Android uygulaması oluşturacağınız Android öğreticisine geçin.

Öğretici: Kullanıcıları oturum açma ve bir Android uygulamasından Microsoft Graph'ı çağırma

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2025-04-16

Aracılığıyla paylaş

Hızlı Başlangıç: Android uygulamasından kullanıcıları oturum açma ve Microsoft Graph API'sini çağırma

Önkoşullar

1. Adım: Uygulamanızı Azure portalında yapılandırma

2. Adım: Projeyi indirme

3. Adım: Uygulamanız yapılandırılmış ve çalışmaya hazır

Örnek nasıl çalışır?

Uygulamaya MSAL ekleme

MSAL içeri aktarmaları

SingleAccountModeFragment.java

Tek hesap MSAL başlatma

Bir kullanıcıda oturum açma

Kullanıcının oturumunu kapatma

Etkileşimli veya sessiz bir şekilde belirteç alma

Hesap yükleme

Microsoft Graph'ı arayın

auth_config_single_account.json

MultipleAccountModeFragment.java

Birden çok hesap MSAL başlatması

Hesap yükleme

Etkileşimli veya sessiz bir şekilde belirteç alma

Hesabı kaldırma

auth_config_multiple_account.json

Yardım ve destek

Sonraki adımlar

Geri Bildirim

Ek kaynaklar