チュートリアル: 認証に Microsoft ID プラットフォームを使用する Android アプリを作成する - Microsoft identity platform

[アーティクル]
02/24/2024

このチュートリアルでは、ユーザーのサインインを処理し、Microsoft Graph API を呼び出すアクセストークンを取得するために Microsoft Entra ID と連携する Android アプリを作成します。

このチュートリアルを完了すると、アプリケーションは、個人用の Microsoft アカウント (outlook.com、live.com など) と、Microsoft Entra ID を使用する会社や組織の職場または学校アカウントのサインインを受け入れるようになります。

このチュートリアルの内容:

Android Studio で Android アプリプロジェクトを作成する
Microsoft Entra 管理センターでアプリを登録する
ユーザーのサインインとサインアウトをサポートするコードを追加する
Microsoft Graph API を呼び出すコードを追加する
アプリケーションをテストする

前提条件

このチュートリアルのしくみ

このチュートリアルで生成されたサンプルアプリがどのように動作するかについてのスクリーンショット。

このチュートリアルのアプリでは、ユーザーにサインインし、ユーザーに代わってデータを取得します。このデータは、承認を要求し、Microsoft ID プラットフォームによって保護される API (Microsoft Graph API) を介してアクセスされます。

このサンプルでは、Microsoft Authentication Library (MSAL) for Android の com.microsoft.identity.client を使用して認証を実装します。

プロジェクトの作成

Android アプリケーションがまだない場合は、これらの手順に従って新しいプロジェクトを作成します。

Android Studio を開き、 [Start a new Android Studio project](新しい Android Studio プロジェクトを開始する) を選択します。
[Basic Activity](基本アクティビティ) を選択し、[Next](次へ) を選択します。
アプリケーションの名前 (「MSALAndroidapp」など) を入力します。
この後の手順で使用するパッケージ名を記録します。
言語を [Kotlin] から [Java] に変更します。
[Minimum SDK API level] (最小 SDK API レベル) を API 16 以上に設定し、[完了] を選択します。

Microsoft Entra ID にアプリケーションを登録する

ヒント

この記事の手順は、開始するポータルによって若干異なる場合があります。

アプリケーション開発者以上として Microsoft Entra 管理センターにサインインします。
複数のテナントにアクセスできる場合は、上部のメニューの [設定] アイコンを使い、[ディレクトリとサブスクリプション] メニューからアプリケーションを登録するテナントに切り替えます。
[ID]>[アプリケーション]>[アプリの登録] を参照します。
[新規登録] を選択します。
アプリケーションの [名前] を入力します。アプリのユーザーにはこの名前が表示されます。後で変更することもできます。
[サポートされているアカウントの種類] に、[任意の組織のディレクトリ (Microsoft Entra ディレクトリ - マルチテナント) 内のアカウントと、個人用の Microsoft アカウント (Skype、Xbox など)] を選択します。さまざまなアカウントの種類の詳細については、[選択に関するヘルプ] オプションを選択します。
[登録] を選択します。
[管理] で、 [認証]>[プラットフォームの追加]>[Android] の順に選択します。
プロジェクトのパッケージ名を入力します。サンプルコードをダウンロードした場合、この値は com.azuresamples.msalandroidapp です。
[Android アプリの構成] ペインの [署名ハッシュ] セクションで、[Generating a development Signature Hash] (開発用署名ハッシュの生成) を選択し、KeyTool コマンドをコマンドラインにコピーします。
- KeyTool.exe は、Java Development Kit (JDK) の一部としてインストールされます。 KeyTool コマンドを実行するには、OpenSSL ツールもインストールする必要があります。詳細については、キーの生成に関する Android のドキュメントを参照してください。
KeyTool によって生成された署名ハッシュを入力します。
[構成] を選択し、後でアプリを構成するときに入力できるように、[Android の構成] ペインに表示される [MSAL 構成] を保存しておきます。
[完了] を選択します。

アプリケーションの作成

Android Studio のプロジェクトウィンドウで、app\src\main\res に移動します。
res を右クリックして、[New](新規)>[Directory](ディレクトリ) を選択します。新しいディレクトリの名前に「raw」と入力し、[OK] を選択します。
app>src>main>res>raw で、auth_config_single_account.json という名前の新しい JSON ファイルを作成し、先ほど保存した MSAL 構成を貼り付けます。

リダイレクト URI の下に、以下を貼り付けます。
```
  "account_mode" : "SINGLE",
```
構成ファイルは次の例のようになります。
```
{
  "client_id": "00001111-aaaa-bbbb-3333-cccc4444",
  "authorization_user_agent": "WEBVIEW",
  "redirect_uri": "msauth://com.azuresamples.msalandroidapp/00001111%cccc4444%3D",
  "broker_redirect_uri_registered": true,
  "account_mode": "SINGLE",
  "authorities": [
    {
      "type": "AAD",
      "audience": {
        "type": "AzureADandPersonalMicrosoftAccount",
        "tenant_id": "common"
      }
    }
  ]
}
```
このチュートリアルでは単一アカウントモードでアプリを構成する方法のみを紹介しているため、詳細については、単一アカウントモードと複数アカウントモードに関する記事およびアプリの構成に関する記事を参照してください
'WEBVIEW' を使用することをお勧めします。アプリで "authorization_user_agent" を 'BROWSER' として構成する場合は、次の更新を行う必要があります。 a) auth_config_single_account.jsonを "authorization_user_agent": "Browser" で更新します。 b) AndroidManifest.xml を更新します。アプリで app>src>main>AndroidManifest.xml に移動し、BrowserTabActivity アクティビティを <application> 要素の子として追加します。このエントリにより、Microsoft Entra ID は認証の完了後にアプリケーションにコールバックできます。
```

<activity
    android:name="com.microsoft.identity.client.BrowserTabActivity"
    android:exported="true">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="msauth"
            android:host="Enter_the_Package_Name"
            android:path="/Enter_the_Signature_Hash" />
    </intent-filter>
</activity>
```
- パッケージ名を使用して android:host=. 値を置き換えます。 com.azuresamples.msalandroidapp のようになります。
- 署名ハッシュを使用して android:path= 値を置き換えます。署名ハッシュの先頭に / があることを確認します。 /aB1cD2eF3gH4+iJ5kL6-mN7oP8q= のようになります。
これらの値は、アプリの登録の [認証] ブレードでも確認できます。

MSAL と関連するライブラリをプロジェクトに追加する

Android Studio プロジェクトウィンドウで、app>build.gradle に移動し、dependencies セクションに次のライブラリを追加します。
```
 implementation 'com.microsoft.identity.client:msal:5.0.0'
 implementation 'com.android.volley:volley:1.2.1'
```
Android Studio プロジェクトウィンドウで settings.gradle を開き、dependencyResolutionManagement>repositories セクションで次の maven リポジトリを宣言します。
```
 maven {
      url 'https://pkgs.dev.azure.com/MicrosoftDeviceSDK/DuoSDK-Public/_packaging/Duo-SDK-Feed/maven/v1'
 }
```
通知バーで [今すぐ同期] を選択します。

必要なフラグメントを作成して更新する

app>src>main>java>com.example(アプリ名) 内で: 次の Android フラグメントを作成します。
- MSGraphRequestWrapper
- OnFragmentInteractionListener
- SingleAccountModeFragment

MSGraphRequestWrapper.java を開き、コードを次のコードスニペットに置き換えて、MSAL によって提供されたトークンを使用して Microsoft Graph API を呼び出します。

 package com.azuresamples.msalandroidapp;

 import android.content.Context;
 import android.util.Log;

 import androidx.annotation.NonNull;

 import com.android.volley.DefaultRetryPolicy;
 import com.android.volley.Request;
 import com.android.volley.RequestQueue;
 import com.android.volley.Response;
 import com.android.volley.toolbox.JsonObjectRequest;
 import com.android.volley.toolbox.Volley;

 import org.json.JSONObject;

 import java.util.HashMap;
 import java.util.Map;

 public class MSGraphRequestWrapper {
     private static final String TAG = MSGraphRequestWrapper.class.getSimpleName();

     // See: https://docs.microsoft.com/en-us/graph/deployments#microsoft-graph-and-graph-explorer-service-root-endpoints
     public static final String MS_GRAPH_ROOT_ENDPOINT = "https://graph.microsoft.com/";

     /**
      * Use Volley to make an HTTP request with
      * 1) a given MSGraph resource URL
      * 2) an access token
      * to obtain MSGraph data.
      **/
     public static void callGraphAPIUsingVolley(@NonNull final Context context,
                                                @NonNull final String graphResourceUrl,
                                                @NonNull final String accessToken,
                                                @NonNull final Response.Listener<JSONObject> responseListener,
                                                @NonNull final Response.ErrorListener errorListener) {
         Log.d(TAG, "Starting volley request to graph");

         /* Make sure we have a token to send to graph */
         if (accessToken == null || accessToken.length() == 0) {
             return;
         }

         RequestQueue queue = Volley.newRequestQueue(context);
         JSONObject parameters = new JSONObject();

         try {
             parameters.put("key", "value");
         } catch (Exception e) {
             Log.d(TAG, "Failed to put parameters: " + e.toString());
         }

         JsonObjectRequest request = new JsonObjectRequest(Request.Method.GET, graphResourceUrl,
                 parameters, responseListener, errorListener) {
             @Override
             public Map<String, String> getHeaders() {
                 Map<String, String> headers = new HashMap<>();
                 headers.put("Authorization", "Bearer " + accessToken);
                 return headers;
             }
         };

         Log.d(TAG, "Adding HTTP GET to Queue, Request: " + request.toString());

         request.setRetryPolicy(new DefaultRetryPolicy(
                 3000,
                 DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
                 DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
         queue.add(request);
     }
 }

OnFragmentInteractionListener.java を開き、コードを次のコードスニペットに置き換えて、さまざまなフラグメント間で通信できるようにします。

 package com.azuresamples.msalandroidapp;

 /**
  * This interface must be implemented by activities that contain this
  * fragment to allow an interaction in this fragment to be communicated
  * to the activity and potentially other fragments contained in that
  * activity.
  * <p>
  * See the Android Training lesson <a href=
  * "http://developer.android.com/training/basics/fragments/communicating.html"
  * >Communicating with Other Fragments</a> for more information.
  */
 public interface OnFragmentInteractionListener {
 }

SingleAccountModeFragment.java を開き、コードを次のコードスニペットに置き換えて、単一アカウントアプリケーションを初期化し、ユーザーアカウントを読み込み、Microsoft Graph API を呼び出すトークンを取得します。

 package com.azuresamples.msalandroidapp;

 import android.os.Bundle;

 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.fragment.app.Fragment;

 import android.util.Log;
 import android.view.LayoutInflater;
 import android.view.View;
 import android.view.ViewGroup;
 import android.widget.Button;
 import android.widget.TextView;
 import android.widget.Toast;

 import com.android.volley.Response;
 import com.android.volley.VolleyError;
 import com.microsoft.identity.client.AuthenticationCallback;
 import com.microsoft.identity.client.IAccount;
 import com.microsoft.identity.client.IAuthenticationResult;
 import com.microsoft.identity.client.IPublicClientApplication;
 import com.microsoft.identity.client.ISingleAccountPublicClientApplication;
 import com.microsoft.identity.client.PublicClientApplication;
 import com.microsoft.identity.client.SilentAuthenticationCallback;
 import com.microsoft.identity.client.exception.MsalClientException;
 import com.microsoft.identity.client.exception.MsalException;
 import com.microsoft.identity.client.exception.MsalServiceException;
 import com.microsoft.identity.client.exception.MsalUiRequiredException;

 import org.json.JSONObject;

 /**
  * Implementation sample for 'Single account' mode.
  * <p>
  * If your app only supports one account being signed-in at a time, this is for you.
  * This requires "account_mode" to be set as "SINGLE" in the configuration file.
  * (Please see res/raw/auth_config_single_account.json for more info).
  * <p>
  * Please note that switching mode (between 'single' and 'multiple' might cause a loss of data.
  */
 public class SingleAccountModeFragment extends Fragment {
     private static final String TAG = SingleAccountModeFragment.class.getSimpleName();

     /* UI & Debugging Variables */
     Button signInButton;
     Button signOutButton;
     Button callGraphApiInteractiveButton;
     Button callGraphApiSilentButton;
     TextView scopeTextView;
     TextView graphResourceTextView;
     TextView logTextView;
     TextView currentUserTextView;
     TextView deviceModeTextView;

     /* Azure AD Variables */
     private ISingleAccountPublicClientApplication mSingleAccountApp;
     private IAccount mAccount;

     @Override
     public View onCreateView(LayoutInflater inflater,
                              ViewGroup container,
                              Bundle savedInstanceState) {
         // Inflate the layout for this fragment
         final View view = inflater.inflate(R.layout.fragment_single_account_mode, container, false);
         initializeUI(view);

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

         return view;
     }

     /**
      * Initializes UI variables and callbacks.
      */
     private void initializeUI(@NonNull final View view) {
         signInButton = view.findViewById(R.id.btn_signIn);
         signOutButton = view.findViewById(R.id.btn_removeAccount);
         callGraphApiInteractiveButton = view.findViewById(R.id.btn_callGraphInteractively);
         callGraphApiSilentButton = view.findViewById(R.id.btn_callGraphSilently);
         scopeTextView = view.findViewById(R.id.scope);
         graphResourceTextView = view.findViewById(R.id.msgraph_url);
         logTextView = view.findViewById(R.id.txt_log);
         currentUserTextView = view.findViewById(R.id.current_user);
         deviceModeTextView = view.findViewById(R.id.device_mode);

         final String defaultGraphResourceUrl = MSGraphRequestWrapper.MS_GRAPH_ROOT_ENDPOINT + "v1.0/me";
         graphResourceTextView.setText(defaultGraphResourceUrl);

         signInButton.setOnClickListener(new View.OnClickListener() {
             public void onClick(View v) {
                 if (mSingleAccountApp == null) {
                     return;
                 }

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

         signOutButton.setOnClickListener(new View.OnClickListener() {
             public void onClick(View v) {
                 if (mSingleAccountApp == null) {
                     return;
                 }

                 /**
                  * Removes the signed-in account and cached tokens from this app (or device, if the device is in shared mode).
                  */
                 mSingleAccountApp.signOut(new ISingleAccountPublicClientApplication.SignOutCallback() {
                     @Override
                     public void onSignOut() {
                         mAccount = null;
                         updateUI();
                         showToastOnSignOut();
                     }

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

         callGraphApiInteractiveButton.setOnClickListener(new View.OnClickListener() {
             public void onClick(View v) {
                 if (mSingleAccountApp == null) {
                     return;
                 }

                 /**
                  * 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());
             }
         });

         callGraphApiSilentButton.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View v) {
                 if (mSingleAccountApp == null) {
                     return;
                 }

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

     }

     @Override
     public void onResume() {
         super.onResume();

         /**
          * The account may have been removed from the device (if broker is in use).
          *
          * In shared device mode, the account might be signed in/out by other apps while this app is not in focus.
          * Therefore, we want to update the account state by invoking loadAccount() here.
          */
         loadAccount();
     }

     /**
      * Extracts a scope array from a text field,
      * i.e. from "User.Read User.ReadWrite" to ["user.read", "user.readwrite"]
      */
     private String[] getScopes() {
         return scopeTextView.getText().toString().toLowerCase().split(" ");
     }

     /**
      * Load the currently signed-in account, if there's any.
      */
     private void loadAccount() {
         if (mSingleAccountApp == null) {
             return;
         }

         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.
                 mAccount = activeAccount;
                 updateUI();
             }

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

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

     /**
      * Callback used in for silent acquireToken calls.
      */
     private SilentAuthenticationCallback getAuthSilentCallback() {
         return new SilentAuthenticationCallback() {

             @Override
             public void onSuccess(IAuthenticationResult authenticationResult) {
                 Log.d(TAG, "Successfully authenticated");

                 /* Successfully got a token, use it to call a protected resource - MSGraph */
                 callGraphAPI(authenticationResult);
             }

             @Override
             public void onError(MsalException exception) {
                 /* Failed to acquireToken */
                 Log.d(TAG, "Authentication failed: " + exception.toString());
                 displayError(exception);

                 if (exception instanceof MsalClientException) {
                     /* Exception inside MSAL, more info inside MsalError.java */
                 } else if (exception instanceof MsalServiceException) {
                     /* Exception when communicating with the STS, likely config issue */
                 } else if (exception instanceof MsalUiRequiredException) {
                     /* Tokens expired or no session, retry with interactive */
                 }
             }
         };
     }

     /**
      * Callback used for interactive request.
      * If succeeds we use the access token to call the Microsoft Graph.
      * Does not check cache.
      */
     private AuthenticationCallback getAuthInteractiveCallback() {
         return new AuthenticationCallback() {

             @Override
             public void onSuccess(IAuthenticationResult authenticationResult) {
                 /* Successfully got a token, use it to call a protected resource - MSGraph */
                 Log.d(TAG, "Successfully authenticated");
                 Log.d(TAG, "ID Token: " + authenticationResult.getAccount().getClaims().get("id_token"));

                 /* Update account */
                 mAccount = authenticationResult.getAccount();
                 updateUI();

                 /* call graph */
                 callGraphAPI(authenticationResult);
             }

             @Override
             public void onError(MsalException exception) {
                 /* Failed to acquireToken */
                 Log.d(TAG, "Authentication failed: " + exception.toString());
                 displayError(exception);

                 if (exception instanceof MsalClientException) {
                     /* Exception inside MSAL, more info inside MsalError.java */
                 } else if (exception instanceof MsalServiceException) {
                     /* Exception when communicating with the STS, likely config issue */
                 }
             }

             @Override
             public void onCancel() {
                 /* User canceled the authentication */
                 Log.d(TAG, "User cancelled login.");
             }
         };
     }

     /**
      * Make an HTTP request to obtain MSGraph data
      */
     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 */
                         Log.d(TAG, "Response: " + response.toString());
                         displayGraphResult(response);
                     }
                 },
                 new Response.ErrorListener() {
                     @Override
                     public void onErrorResponse(VolleyError error) {
                         Log.d(TAG, "Error: " + error.toString());
                         displayError(error);
                     }
                 });
     }

     //
     // Helper methods manage UI updates
     // ================================
     // displayGraphResult() - Display the graph response
     // displayError() - Display the graph response
     // updateSignedInUI() - Updates UI when the user is signed in
     // updateSignedOutUI() - Updates UI when app sign out succeeds
     //

     /**
      * Display the graph response
      */
     private void displayGraphResult(@NonNull final JSONObject graphResponse) {
         logTextView.setText(graphResponse.toString());
     }

     /**
      * Display the error message
      */
     private void displayError(@NonNull final Exception exception) {
         logTextView.setText(exception.toString());
     }

     /**
      * Updates UI based on the current account.
      */
     private void updateUI() {
         if (mAccount != null) {
             signInButton.setEnabled(false);
             signOutButton.setEnabled(true);
             callGraphApiInteractiveButton.setEnabled(true);
             callGraphApiSilentButton.setEnabled(true);
             currentUserTextView.setText(mAccount.getUsername());
         } else {
             signInButton.setEnabled(true);
             signOutButton.setEnabled(false);
             callGraphApiInteractiveButton.setEnabled(false);
             callGraphApiSilentButton.setEnabled(false);
             currentUserTextView.setText("None");
         }

         deviceModeTextView.setText(mSingleAccountApp.isSharedDevice() ? "Shared" : "Non-shared");
     }

     /**
      * Updates UI when app sign out succeeds
      */
     private void showToastOnSignOut() {
         final String signOutText = "Signed Out.";
         currentUserTextView.setText("");
         Toast.makeText(getContext(), signOutText, Toast.LENGTH_SHORT)
                 .show();
     }
 }

MainActivity.java を開き、コードを次のコードスニペットに置き換えて UI を管理します。

 package com.azuresamples.msalandroidapp;

 import android.os.Bundle;

 import androidx.annotation.NonNull;
 import androidx.appcompat.app.ActionBarDrawerToggle;
 import androidx.appcompat.app.AppCompatActivity;
 import androidx.appcompat.widget.Toolbar;
 import androidx.constraintlayout.widget.ConstraintLayout;
 import androidx.core.view.GravityCompat;

 import android.view.MenuItem;
 import android.view.View;

 import androidx.drawerlayout.widget.DrawerLayout;
 import androidx.fragment.app.Fragment;
 import androidx.fragment.app.FragmentTransaction;


 import com.google.android.material.navigation.NavigationView;

 public class MainActivity extends AppCompatActivity
         implements NavigationView.OnNavigationItemSelectedListener,
         OnFragmentInteractionListener{

     enum AppFragment {
         SingleAccount
     }

     private AppFragment mCurrentFragment;

     private ConstraintLayout mContentMain;

     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);

         mContentMain = findViewById(R.id.content_main);

         Toolbar toolbar = findViewById(R.id.toolbar);
         setSupportActionBar(toolbar);
         DrawerLayout drawer = findViewById(R.id.drawer_layout);
         NavigationView navigationView = findViewById(R.id.nav_view);
         ActionBarDrawerToggle toggle = new ActionBarDrawerToggle(
                 this, drawer, toolbar, R.string.navigation_drawer_open, R.string.navigation_drawer_close);
         drawer.addDrawerListener(toggle);
         toggle.syncState();
         navigationView.setNavigationItemSelectedListener(this);

         //Set default fragment
         navigationView.setCheckedItem(R.id.nav_single_account);
         setCurrentFragment(AppFragment.SingleAccount);
     }

     @Override
     public boolean onNavigationItemSelected(final MenuItem item) {
         final DrawerLayout drawer = findViewById(R.id.drawer_layout);
         drawer.addDrawerListener(new DrawerLayout.DrawerListener() {
             @Override
             public void onDrawerSlide(@NonNull View drawerView, float slideOffset) { }

             @Override
             public void onDrawerOpened(@NonNull View drawerView) { }

             @Override
             public void onDrawerClosed(@NonNull View drawerView) {
                 // Handle navigation view item clicks here.
                 int id = item.getItemId();

                 if (id == R.id.nav_single_account) {
                     setCurrentFragment(AppFragment.SingleAccount);
                 }


                 drawer.removeDrawerListener(this);
             }

             @Override
             public void onDrawerStateChanged(int newState) { }
         });

         drawer.closeDrawer(GravityCompat.START);
         return true;
     }

     private void setCurrentFragment(final AppFragment newFragment){
         if (newFragment == mCurrentFragment) {
             return;
         }

         mCurrentFragment = newFragment;
         setHeaderString(mCurrentFragment);
         displayFragment(mCurrentFragment);
     }

     private void setHeaderString(final AppFragment fragment){
         switch (fragment) {
             case SingleAccount:
                 getSupportActionBar().setTitle("Single Account Mode");
                 return;

         }
     }

     private void displayFragment(final AppFragment fragment){
         switch (fragment) {
             case SingleAccount:
                 attachFragment(new com.azuresamples.msalandroidapp.SingleAccountModeFragment());
                 return;

         }
     }

     private void attachFragment(final Fragment fragment) {
         getSupportFragmentManager()
                 .beginTransaction()
                 .setTransitionStyle(FragmentTransaction.TRANSIT_FRAGMENT_FADE)
                 .replace(mContentMain.getId(),fragment)
                 .commit();
     }
 }

Note

Android プロジェクトのパッケージ名と一致するようにパッケージ名を更新してください。

Layout

レイアウトは、UI コンポーネントの配置を指定して、ユーザーインターフェイスの視覚的構造と外観を定義するファイルです。 XML で記述されています。このチュートリアルで UI をモデル化する場合は、次の XML サンプルが提供されます。

app>src>main>res>layout>activity_main.xml 内で: activity_main.xml の内容を次のコードスニペットに置き換えて、ボタンとテキストボックスを表示します。

 <?xml version="1.0" encoding="utf-8"?>
 <androidx.drawerlayout.widget.DrawerLayout xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto"
     xmlns:tools="http://schemas.android.com/tools"
     android:id="@+id/drawer_layout"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     android:fitsSystemWindows="true"
     tools:openDrawer="start">

     <include
         layout="@layout/app_bar_main"
         android:layout_width="match_parent"
         android:layout_height="match_parent" />

     <com.google.android.material.navigation.NavigationView
         android:id="@+id/nav_view"
         android:layout_width="wrap_content"
         android:layout_height="match_parent"
         android:layout_gravity="start"
         android:fitsSystemWindows="true"
         app:headerLayout="@layout/nav_header_main"
         app:menu="@menu/activity_main_drawer" />

 </androidx.drawerlayout.widget.DrawerLayout>

app>src>main>res>layout>activity_main.xml を使用します。フォルダーに app_bar_main.xml がない場合は、次のコードスニペットを作成して追加します。

<?xml version="1.0" encoding="utf-8"?>
<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <com.google.android.material.appbar.AppBarLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:theme="@style/AppTheme.AppBarOverlay">

        <androidx.appcompat.widget.Toolbar
            android:id="@+id/toolbar"
            android:layout_width="match_parent"
            android:layout_height="?attr/actionBarSize"
            android:background="?attr/colorPrimary"
            app:popupTheme="@style/AppTheme.PopupOverlay" />

    </com.google.android.material.appbar.AppBarLayout>

    <include layout="@layout/content_main" />

</androidx.coordinatorlayout.widget.CoordinatorLayout>

app>src>main>res>layout>content_main.xml を使用します。フォルダーに content_main.xml がない場合は、次のコードスニペットを作成して追加します。

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/content_main"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:layout_behavior="@string/appbar_scrolling_view_behavior"
    tools:context=".MainActivity"
    tools:showIn="@layout/app_bar_main">

</androidx.constraintlayout.widget.ConstraintLayout>

app>src>main>res>layout>fragment_m_s_graph_request_wrapper.xml を使用します。フォルダーに fragment_m_s_graph_request_wrapper.xml がない場合は、次のコードスニペットを作成して追加します。

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MSGraphRequestWrapper">

    <!-- TODO: Update blank fragment layout -->
    <TextView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:text="@string/hello_blank_fragment" />

</FrameLayout>

app>src>main>res>layout>fragment_on_interaction_listener.xml を使用します。フォルダーに fragment_on_interaction_listener.xml がない場合は、次のコードスニペットを作成して追加します。

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".OnFragmentInteractionListener">

    <!-- TODO: Update blank fragment layout -->
    <TextView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:text="@string/hello_blank_fragment" />

</FrameLayout>

app>src>main>res>layout>fragment_single_account_mode.xml を使用します。フォルダーに fragment_single_account_mode.xml がない場合は、次のコードスニペットを作成して追加します。

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".SingleAccountModeFragment">

    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".SingleAccountModeFragment">

        <LinearLayout
            android:id="@+id/activity_main"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:orientation="vertical"
            android:paddingLeft="@dimen/activity_horizontal_margin"
            android:paddingRight="@dimen/activity_horizontal_margin"
            android:paddingBottom="@dimen/activity_vertical_margin">

            <LinearLayout
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:orientation="horizontal"
                android:paddingTop="5dp"
                android:paddingBottom="5dp"
                android:weightSum="10">

                <TextView
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="3"
                    android:layout_gravity="center_vertical"
                    android:textStyle="bold"
                    android:text="Scope" />

                <LinearLayout
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:orientation="vertical"
                    android:layout_weight="7">

                    <EditText
                        android:id="@+id/scope"
                        android:layout_height="wrap_content"
                        android:layout_width="match_parent"
                        android:text="user.read"
                        android:textSize="12sp" />

                    <TextView
                        android:layout_height="wrap_content"
                        android:layout_width="match_parent"
                        android:paddingLeft="5dp"
                        android:text="Type in scopes delimited by space"
                        android:textSize="10sp"  />

                </LinearLayout>
            </LinearLayout>

            <LinearLayout
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:orientation="horizontal"
                android:paddingTop="5dp"
                android:paddingBottom="5dp"
                android:weightSum="10">

                <TextView
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="3"
                    android:layout_gravity="center_vertical"
                    android:textStyle="bold"
                    android:text="MSGraph Resource URL" />

                <LinearLayout
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:orientation="vertical"
                    android:layout_weight="7">

                    <EditText
                        android:id="@+id/msgraph_url"
                        android:layout_height="wrap_content"
                        android:layout_width="match_parent"
                        android:textSize="12sp" />
                </LinearLayout>
            </LinearLayout>

            <LinearLayout
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:orientation="horizontal"
                android:paddingTop="5dp"
                android:paddingBottom="5dp"
                android:weightSum="10">

                <TextView
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="3"
                    android:textStyle="bold"
                    android:text="Signed-in user" />

                <TextView
                    android:id="@+id/current_user"
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:paddingLeft="5dp"
                    android:layout_weight="7"
                    android:text="None" />
            </LinearLayout>

            <LinearLayout
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:orientation="horizontal"
                android:paddingTop="5dp"
                android:paddingBottom="5dp"
                android:weightSum="10">

                <TextView
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="3"
                    android:textStyle="bold"
                    android:text="Device mode" />

                <TextView
                    android:id="@+id/device_mode"
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:paddingLeft="5dp"
                    android:layout_weight="7"
                    android:text="None" />
            </LinearLayout>

            <LinearLayout
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:orientation="horizontal"
                android:paddingTop="5dp"
                android:paddingBottom="5dp"
                android:weightSum="10">

                <Button
                    android:id="@+id/btn_signIn"
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="5"
                    android:gravity="center"
                    android:text="Sign In"/>

                <Button
                    android:id="@+id/btn_removeAccount"
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="5"
                    android:gravity="center"
                    android:text="Sign Out"
                    android:enabled="false"/>
            </LinearLayout>


            <LinearLayout
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:gravity="center"
                android:orientation="horizontal">

                <Button
                    android:id="@+id/btn_callGraphInteractively"
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="5"
                    android:text="Get Graph Data Interactively"
                    android:enabled="false"/>

                <Button
                    android:id="@+id/btn_callGraphSilently"
                    android:layout_width="0dp"
                    android:layout_height="wrap_content"
                    android:layout_weight="5"
                    android:text="Get Graph Data Silently"
                    android:enabled="false"/>
            </LinearLayout>


            <TextView
                android:id="@+id/txt_log"
                android:layout_width="match_parent"
                android:layout_height="0dp"
                android:layout_marginTop="20dp"
                android:layout_weight="0.8"
                android:text="Output goes here..." />

        </LinearLayout>
    </LinearLayout>

</FrameLayout>

app>src>main>res>layout>nav_header_main.xml を使用します。フォルダーに nav_header_main.xml がない場合は、次のコードスニペットを作成して追加します。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="@dimen/nav_header_height"
    android:background="@drawable/side_nav_bar"
    android:gravity="bottom"
    android:orientation="vertical"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:theme="@style/ThemeOverlay.AppCompat.Dark">

    <ImageView
        android:id="@+id/imageView"
        android:layout_width="66dp"
        android:layout_height="72dp"
        android:contentDescription="@string/nav_header_desc"
        android:paddingTop="@dimen/nav_header_vertical_spacing"
        app:srcCompat="@drawable/microsoft_logo" />

    <TextView
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:paddingTop="@dimen/nav_header_vertical_spacing"
        android:text="Azure Samples"
        android:textAppearance="@style/TextAppearance.AppCompat.Body1" />

    <TextView
        android:id="@+id/textView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="MSAL Android" />

</LinearLayout>

app>src>main>res>menu>activity_main_drawer.xml を使用します。フォルダーに activity_main_drawer.xml がない場合は、次のコードスニペットを作成して追加します。

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    tools:showIn="navigation_view">
    <group android:checkableBehavior="single">
        <item
            android:id="@+id/nav_single_account"
            android:icon="@drawable/ic_single_account_24dp"
            android:title="Single Account Mode" />

    </group>
</menu>

app>src>main>res>values>dimens.xml を使用します。 dimens.xml の内容を次のコードスニペットに置き換えます。

<resources>
    <dimen name="fab_margin">16dp</dimen>
    <dimen name="activity_horizontal_margin">16dp</dimen>
    <dimen name="activity_vertical_margin">16dp</dimen>
    <dimen name="nav_header_height">176dp</dimen>
    <dimen name="nav_header_vertical_spacing">8dp</dimen>
</resources>

In app>src>main>res>values>colors.xml を使用します。 colors.xml の内容を次のコードスニペットに置き換えます。

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="purple_200">#FFBB86FC</color>
    <color name="purple_500">#FF6200EE</color>
    <color name="purple_700">#FF3700B3</color>
    <color name="teal_200">#FF03DAC5</color>
    <color name="teal_700">#FF018786</color>
    <color name="black">#FF000000</color>
    <color name="white">#FFFFFFFF</color>
    <color name="colorPrimary">#008577</color>
    <color name="colorPrimaryDark">#00574B</color>
    <color name="colorAccent">#D81B60</color>
</resources>

app>src>main>res>values>strings.xml を使用します。 strings.xml の内容を次のコードスニペットに置き換えます。

<resources>
    <string name="app_name">MSALAndroidapp</string>
    <string name="action_settings">Settings</string>
    <!-- Strings used for fragments for navigation -->
    <string name="first_fragment_label">First Fragment</string>
    <string name="second_fragment_label">Second Fragment</string>
    <string name="nav_header_desc">Navigation header</string>
    <string name="navigation_drawer_open">Open navigation drawer</string>
    <string name="navigation_drawer_close">Close navigation drawer</string>
    <string name="next">Next</string>
    <string name="previous">Previous</string>

    <string name="hello_first_fragment">Hello first fragment</string>
    <string name="hello_second_fragment">Hello second fragment. Arg: %1$s</string>
    <!-- TODO: Remove or change this placeholder text -->
    <string name="hello_blank_fragment">Hello blank fragment</string>
</resources>

app>src>main>res>values>styles.xml を使用します。フォルダーに styles.xml がない場合は、次のコードスニペットを作成して追加します。

<resources>

<!-- Base application theme. -->
<style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
    <!-- Customize your theme here. -->
    <item name="colorPrimary">@color/colorPrimary</item>
    <item name="colorPrimaryDark">@color/colorPrimaryDark</item>
    <item name="colorAccent">@color/colorAccent</item>
</style>

<style name="AppTheme.NoActionBar">
    <item name="windowActionBar">false</item>
    <item name="windowNoTitle">true</item>
</style>

<style name="AppTheme.AppBarOverlay" parent="ThemeOverlay.AppCompat.Dark.ActionBar" />

<style name="AppTheme.PopupOverlay" parent="ThemeOverlay.AppCompat.Light" />

</resources>

app>src>main>res>values>themes.xml を使用します。 themes.xml の内容を次のコードスニペットに置き換えます。

<resources xmlns:tools="http://schemas.android.com/tools">
    <!-- Base application theme. -->
    <style name="Theme.MSALAndroidapp" parent="Theme.MaterialComponents.DayNight.DarkActionBar">
        <!-- Primary brand color. -->
        <item name="colorPrimary">@color/purple_500</item>
        <item name="colorPrimaryVariant">@color/purple_700</item>
        <item name="colorOnPrimary">@color/white</item>
        <!-- Secondary brand color. -->
        <item name="colorSecondary">@color/teal_200</item>
        <item name="colorSecondaryVariant">@color/teal_700</item>
        <item name="colorOnSecondary">@color/black</item>
        <!-- Status bar color. -->
        <item name="android:statusBarColor" tools:targetApi="21">?attr/colorPrimaryVariant</item>
        <!-- Customize your theme here. -->
    </style>

    <style name="Theme.MSALAndroidapp.NoActionBar">
        <item name="windowActionBar">false</item>
        <item name="windowNoTitle">true</item>
    </style>

    <style name="Theme.MSALAndroidapp.AppBarOverlay" parent="ThemeOverlay.AppCompat.Dark.ActionBar" />

    <style name="Theme.MSALAndroidapp.PopupOverlay" parent="ThemeOverlay.AppCompat.Light" />
</resources>

app>src>main>res>drawable>ic_single_account_24dp.xml を使用します。フォルダーに ic_single_account_24dp.xml がない場合は、次のコードスニペットを作成して追加します。

<vector xmlns:android="http://schemas.android.com/apk/res/android"
android:width="24dp"
android:height="24dp"
android:viewportWidth="24.0"
android:viewportHeight="24.0">
<path
    android:fillColor="#FF000000"
    android:pathData="M12,12c2.21,0 4,-1.79 4,-4s-1.79,-4 -4,-4 -4,1.79 -4,4 1.79,4 4,4zM12,14c-2.67,0 -8,1.34 -8,4v2h16v-2c0,-2.66 -5.33,-4 -8,-4z"/>
</vector>

app>src>main>res>drawable>side_nav_bar.xml を使用します。フォルダーに side_nav_bar.xml がない場合は、次のコードスニペットを作成して追加します。

<shape xmlns:android="http://schemas.android.com/apk/res/android"
android:shape="rectangle">
<gradient
    android:angle="135"
    android:centerColor="#009688"
    android:endColor="#00695C"
    android:startColor="#4DB6AC"
    android:type="linear" />
</shape>

app>src>main>res>drawable を使用します。フォルダーに、microsoft_logo.png という名前の png Microsoft ロゴを追加します。

UI を XML で宣言すると、アプリの表示を、その動作を制御するコードから分離できます。 Android レイアウトの詳細については、「レイアウト」を参照してください

アプリをテストする

ローカルで実行する

アプリをビルドし、テストデバイスまたはエミュレーターに展開します。サインインして、Microsoft Entra ID または個人用 Microsoft アカウントのトークンを取得できるようになります。

サインインした後、Microsoft Graph の /me エンドポイントから返されたデータがアプリに表示されます。

ユーザーは、アプリに初めてサインインするときに、Microsoft Identity から、要求されたアクセス許可に同意するよう求められます。一部の Microsoft Entra テナントではユーザーによる同意が無効になっており、全ユーザーに代わって管理者が同意を行う必要があります。このシナリオをサポートするには、独自のテナントを作成するか、管理者の同意を受け取る必要があります。

リソースをクリーンアップする

必要がなくなったら、「アプリケーションの登録」の手順で作成したアプリオブジェクトを削除します。

ヘルプとサポート

サポートが必要な場合、問題をレポートする場合、またはサポートオプションについて知りたい場合は、開発者向けのヘルプとサポートに関するページを参照してください。

次のステップ

さらに複雑なシナリオを試したい方は、GitHub で完成版のコードサンプルを参照してください。

保護された Web API を呼び出すモバイルアプリの作成の詳細については、複数のパートで構成されるシナリオシリーズで以下を参照してください。

次の方法で共有

前提条件

このチュートリアルのしくみ

プロジェクトの作成

Microsoft Entra ID にアプリケーションを登録する

アプリケーションの作成

MSAL と関連するライブラリをプロジェクトに追加する

必要なフラグメントを作成して更新する

Layout

アプリをテストする

ローカルで実行する

リソースをクリーンアップする

ヘルプとサポート

次のステップ

フィードバック

その他のリソース

次の方法で共有

チュートリアル:Android アプリケーションからユーザーをサインインさせて Microsoft Graph API を呼び出す

前提条件

このチュートリアルのしくみ

プロジェクトの作成

Microsoft Entra ID にアプリケーションを登録する

アプリケーションの作成

MSAL と関連するライブラリをプロジェクトに追加する

必要なフラグメントを作成して更新する

Layout

アプリをテストする

ローカルで実行する

承認

リソースをクリーンアップする

ヘルプとサポート

次のステップ

フィードバック

その他のリソース