.NET

• ユーザーはサインインする必要がありません。
• 適切な権限を持つ API キーの認証情報を作成する必要があります。
• API キーは長期間のアクセス トークンです。
• サービス使用料は、API キーの所有者/開発者に請求されます。
• 実装が最も簡単な認証方法です。
• 新規の ArcGIS 開発者に推奨される方法です。

詳しくは API キー認証をご覧ください。

このチュートリアルで使用するセキュアなリソースにアクセスする権限を持つ、新しい API キーのアクセス トークンを作成します。

1. API キーの作成のチュートリアルを完了し、以下の権限を持つ API キーを作成します。
   • Privileges
     • Location services > Basemaps
2. API キーのアクセス トークン をコピーし、安全な場所に貼り付けます。これは後のステップで使用します。

• ユーザーは、ArcGIS アカウントでサインインする必要があります。
• ユーザー アカウントには、アプリケーションで使用する ArcGIS サービスにアクセスする権限が必要です。
• OAuth 認証情報の作成が必要です。
• アプリケーションには、リダイレクト URL とクライアント ID を使用します。
• サービスの使用料は、アプリケーションにサインインしたユーザーの組織に請求されます。

詳しくは、ユーザー認証をご覧ください。

このチュートリアルで使用するセキュアなリソースにアクセスするための新しい OAuth 認証情報を作成します。

1. ユーザー認証用の OAuth 認証情報を作成するチュートリアルを完了し、Client ID と Redirect URL を取得してください。

   Client ID は、認証サーバー上でアプリを一意に識別するものです。サーバーが指定された Client ID を持つアプリを見つけられない場合、認証は続行されません。

   Redirect URL（Callback URL とも呼ばれます）は、OAuth ログイン後にシステムが制御をアプリに戻す際、認証サーバーからの応答を識別するために使用されます。Redirect URL は、必ずしもユーザーが移動できる有効なエンドポイントを表すわけではないため、my-app://auth のようなカスタム スキームを使用できます。アプリのコードで使用される Redirect URL が、認証サーバーで設定された Redirect URL と一致していることを確認することが重要です。

2. ClientID と Redirect URL をコピーして安全な場所に貼り付けます。これらは後のステップで使用します。

このアプリケーションにアクセスするすべてのユーザーには、ベースマップ スタイル サービスにアクセスするためのアカウント権限が必要です。

1. ソリューション エクスプローラーで、App.xaml のノードを展開し、App.xaml.cs をダブルクリックして開きます。

2. App クラスで、OnStartup() 関数のオーバーライドを追加して、ArcGISRuntimeEnvironment で ApiKey プロパティを設定します。

   App.xaml.cs

   public partial class App : Application
   {
       // 追加開始
       protected override void OnStartup(StartupEventArgs e)
       {
           base.OnStartup(e);
           // 注: API キーをソース コードに保存することはベスト プラクティスではありません。
           // API キーは、チュートリアルの便宜上、ここで参照されています。
           Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "API キー";
       }
       // 追加終了
   }

3. “API キー” は先ほど作成した API キーに置き換えてください。

4. App.xaml.cs ファイルを保存して閉じます。

1. Microsoft.Web.WebView2 NuGet パッケージを追加します。このパッケージは Microsoft Edge WebView2 コントロールを提供し、これによりネイティブ アプリに Web テクノロジー (HTML、CSS、JavaScript) を組み込むことができます。アプリでは、WebView2 コントロールを使用して、ユーザー認証のためのログイン UI を表示します。

   • ソリューション エクスプローラーで[依存関係]を右クリックし、[NuGet パッケージの管理]を選択します。
   • [NuGet パッケージ マネージャー]ウィンドウで、[パッケージ ソース]が nuget.org（右上）に設定されていることを確認します。
   • [参照]タブを選択し、Microsoft.Web.WebView2 を検索します。
   • 検索結果から、Microsoft.Web.WebView2 NuGet パッケージを選択します。
   • [バージョン] ドロップダウンで、パッケージの[最新の安定版]が選択されていることを確認します。
   • [インストール]をクリックします。
   • [変更のプレビュー]ダイアログで、パッケージの依存関係や競合が確認されます。変更内容を確認し、[適用]をクリックしてパッケージのインストールを続行します。
   • [ライセンス同意]ダイアログでライセンス情報を確認し、[同意する]をクリックしてパッケージをプロジェクトに追加します。
   • Visual Studio の[出力]ウィンドウで、パッケージが正常にインストールされたことを確認します。
   • [NuGet パッケージ マネージャー] ウィンドウを閉じます。

2. Visual Studio の [プロジェクト] メニューから、[クラスの追加…] を選択します。クラス名を ArcGISLoginPrompt.cs と指定し、[追加] をクリックします。新しいクラスがプロジェクトに追加され、Visual Studio で開きます。

3. 新しいクラス内のコードをすべて選択して削除してください。

4. 以下のコードをすべてコピーし、プロジェクト内の ArcGISLoginPrompt.cs クラスに貼り付けてください。

   ArcGISLoginPrompt.cs

   // Copyright 2021 Esri.
   //
   // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
   // You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
   //
   // Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
   // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
   // language governing permissions and limitations under the License.
   
   using Esri.ArcGISRuntime.Portal;
   using Esri.ArcGISRuntime.Security;
   using Microsoft.Web.WebView2.Core;
   using Microsoft.Web.WebView2.Wpf;
   using System;
   using System.Collections.Generic;
   using System.Threading.Tasks;
   using System.Windows;
   using System.Windows.Threading;
   
   namespace UserAuth
   {
   
       internal static class ArcGISLoginPrompt
       {
           private const string ArcGISOnlineUrl = "https://www.arcgis.com/sharing/rest";
           // Specify the Client ID and Redirect URL to use with OAuth authentication.
           // See the instructions here for creating OAuth app settings:
           // https://developers.arcgis.com/documentation/security-and-authentication/user-authentication/tutorials/           create-oauth-credentials-user-auth/
   
           private const string AppClientId = "YOUR_CLIENT_ID";
           private const string OAuthRedirectUrl = "YOUR_REDIRECT_URL";
   
           public static async Task<bool> EnsureAGOLCredentialAsync()
           {
               bool loggedIn = false;
   
               try
               {
                   // Create the portal, prompting the user to log in if they haven't already.
                   var portal = await ArcGISPortal.CreateAsync(new Uri(ArcGISOnlineUrl), loginRequired: true);
                   // If the user logged in successfully, the portal's User property will be non-null.
                   loggedIn = portal.User != null;
               }
               catch (OperationCanceledException)
               {
                   // OAuth login was canceled, no need to display error to user.
               }
               catch (Exception ex)
               {
                   // Login failure
                   MessageBox.Show("Login failed: " + ex.Message);
               }
   
               return loggedIn;
           }
   
           public static void RegisterOAuthConfig()
           {
               var userConfig = new OAuthUserConfiguration(new Uri(ArcGISOnlineUrl), AppClientId, new Uri(OAuthRedirectUrl));
               AuthenticationManager.Current.OAuthUserConfigurations.Add(userConfig);
               AuthenticationManager.Current.OAuthHandler = new OAuthAuthorize();
           }
   
           #region OAuth handler
   
           // In a desktop (WPF) app, an IOAuthHandler component is used to handle some of the OAuth details. Specifically, it
           //     implements AuthorizeAsync to show the login UI (generated by the server that hosts secure content) in a web control.
           //     When the user logs in successfully, cancels the login, or closes the window without continuing, the IOAuthAuthorizeHandler
           //     is responsible for obtaining the authorization from the server or raising an OperationCanceledException.
           public class OAuthAuthorize : IOAuthHandler
           {
               // Window to contain the OAuth UI.
               private Window? _authWindow;
   
               // Use a TaskCompletionSource to track the completion of the authorization.
               private TaskCompletionSource<IDictionary<string, string>> _tcs;
   
               // URL for the authorization callback result (the redirect URI configured for your application).
               private string _callbackUrl = "";
   
               // URL that handles the OAuth request.
               private string? _authorizeUrl;
   
               // Function to handle authorization requests, takes the URIs for the secured service, the authorization endpoint, and           the redirect URI.
               public Task<IDictionary<string, string>> LoginAsync(OAuthLoginParameters parameters)
               {
                   if (_tcs != null && !_tcs.Task.IsCompleted)
                       throw new Exception("Task in progress");
   
                   _tcs = new TaskCompletionSource<IDictionary<string, string>>();
   
                   // Store the authorization and redirect URLs.
                   _authorizeUrl = parameters.AuthorizeUri.AbsoluteUri;
                   _callbackUrl = parameters.RedirectUri.AbsoluteUri;
   
                   // Call a function to show the login controls, make sure it runs on the UI thread for this app.
                   Dispatcher dispatcher = Application.Current.Dispatcher;
                   if (dispatcher == null || dispatcher.CheckAccess())
                   {
                       AuthorizeOnUIThread(_authorizeUrl);
                   }
                   else
                   {
                       Action authorizeOnUIAction = () => AuthorizeOnUIThread(_authorizeUrl);
                       dispatcher.BeginInvoke(authorizeOnUIAction);
                   }
   
                   // Return the task associated with the TaskCompletionSource.
                   return _tcs.Task;
               }
   
               // Challenge for OAuth credentials on the UI thread.
               private void AuthorizeOnUIThread(string authorizeUri)
               {
                   // Initialize a WebView2 control to display the authorize page.
                   WebView2 webBrowser = new WebView2() { MinWidth = 500, MinHeight = 500 };
   
                   // Handle the navigation event for the browser to check for a response to the redirect URL.
                   webBrowser.NavigationStarting += WebBrowserOnNavigationStarting;
   
                   // Display the web browser in a new window.
                   _authWindow = new Window
                   {
                       Content = webBrowser,
                       SizeToContent = SizeToContent.WidthAndHeight,
                       WindowStartupLocation = WindowStartupLocation.CenterOwner
                   };
   
                   // Set the app's window as the owner of the browser window (if main window closes, so will the browser).
                   if (Application.Current != null && Application.Current.MainWindow != null)
                   {
                       _authWindow.Owner = Application.Current.MainWindow;
                   }
   
                   // Handle window loaded event as the WebView2 control can only be initialized after it is visible in the UI
                   _authWindow.Loaded += async (s, e) =>
                   {
                       await webBrowser.EnsureCoreWebView2Async();
                       webBrowser.CoreWebView2.Navigate(authorizeUri);
                   };
   
                   // Handle the window closed event
                   _authWindow.Closed += OnWindowClosed;
   
                   // Display the window.
                   _authWindow.ShowDialog();
               }
   
               // Handle the browser window closing.
               private void OnWindowClosed(object? sender, EventArgs e)
               {
                   // If the browser window closes, return the focus to the main window.
                   if (_authWindow != null && _authWindow.Owner != null)
                   {
                       _authWindow.Owner.Focus();
                   }
   
                   // If the task wasn't completed, the user must have closed the window without logging in.
                   if (!_tcs.Task.IsCompleted)
                   {
                       // Set the task completion source exception to indicate a canceled operation.
                       _tcs.SetCanceled();
                   }
   
                   _authWindow = null;
               }
   
               // Handle browser navigation
               private void WebBrowserOnNavigationStarting(object? sender, CoreWebView2NavigationStartingEventArgs e)
               {
                   // Check for a response to the callback url.
                   const string portalApprovalMarker = "/oauth2/approval";
   
                   Uri uri = new Uri(e.Uri);
   
                   // If no browser, uri, or an empty url, return.
                   if (sender == null || uri == null || string.IsNullOrEmpty(uri.AbsoluteUri))
                       return;
   
                   // Check for redirect.
                   bool isRedirected = uri.AbsoluteUri.StartsWith(_callbackUrl) ||
                       _callbackUrl.Contains(portalApprovalMarker) && uri.AbsoluteUri.Contains(portalApprovalMarker);
   
                   // Check if browser was redirected to the callback URL. (This indicates succesful authentication.)
                   if (isRedirected)
                   {
                       e.Cancel = true;
   
                       // Call a helper function to decode the response parameters.
                       IDictionary<string, string> authResponse = DecodeParameters(uri);
   
                       // Set the result for the task completion source.
                       _tcs.SetResult(authResponse);
   
                       // Close the window.
                       if (_authWindow != null)
                       {
                           _authWindow.Close();
                       }
                   }
               }
   
               private static IDictionary<string, string> DecodeParameters(Uri uri)
               {
                   // Create a dictionary of key value pairs returned in an OAuth authorization response URI query string.
                   string answer = "";
   
                   // Get the values from the URI fragment or query string.
                   if (!string.IsNullOrEmpty(uri.Fragment))
                   {
                       answer = uri.Fragment.Substring(1);
                   }
                   else
                   {
                       if (!string.IsNullOrEmpty(uri.Query))
                       {
                           answer = uri.Query.Substring(1);
                       }
                   }
   
                   // Parse parameters into key / value pairs.
                   Dictionary<string, string> keyValueDictionary = new Dictionary<string, string>();
                   string[] keysAndValues = answer.Split(new[] { '&' }, StringSplitOptions.RemoveEmptyEntries);
                   foreach (string kvString in keysAndValues)
                   {
                       string[] pair = kvString.Split('=');
                       string key = pair[0];
                       string value = string.Empty;
                       if (key.Length > 1)
                       {
                           value = Uri.UnescapeDataString(pair[1]);
                       }
   
                       keyValueDictionary.Add(key, value);
                   }
   
                   // Return the dictionary of string keys/values.
                   return keyValueDictionary;
               }
           }
   
           #endregion OAuth handler
       }
   }

5. クライアント ID (AppClientId) とリダイレクト URL (OAuthRedirectUri)の値を追加します。これらは、認証の設定ステップで作成したユーザー認証設定です。

   ArcGISLoginPrompt.cs

   internal static class ArcGISLoginPrompt
       {
           private const string ArcGISOnlineUrl = "https://www.arcgis.com/sharing/rest";
           // Specify the Client ID and Redirect URL to use with OAuth authentication.
           // See the instructions here for creating OAuth app settings:
           // https://developers.arcgis.com/documentation/security-and-authentication/user-authentication/tutorials/create-oauth-credentials-user-auth/
   
           // 更新開始
           private const string AppClientId = "YOUR_CLIENT_ID";
           private const string OAuthRedirectUrl = "YOUR_REDIRECT_URL";
           // 更新終了

6. [ソリューション エクスプローラー] で App.xaml のノードを展開し、App.xaml.cs をダブルクリックして開きます。

7. App クラスで OnStartup() 関数のオーバーライドを追加して、静的 ArcGISLoginPrompt クラスの SetChallengeHandler() メソッドを呼び出します。

   App.xaml.cs

       public partial class App : Application
       {
   
           // 追加開始
           protected override void OnStartup(StartupEventArgs e)
           {
               base.OnStartup(e);
   
               // Call a function to set up the AuthenticationManager for OAuth.
               UserAuth.ArcGISLoginPrompt.RegisterOAuthConfig();
   
           }
           // 追加終了
   
       }
   }

8. App.xaml.cs ファイルを保存して閉じます。

1. Visual Studio のソリューション エクスプローラーで、App.xaml.cs をクリックしてファイルを開きます。

2. ArcGISEnvironment.ApiKey プロパティに API キーのアクセス トークンを設定します。

   App.xaml.cs

           protected override void OnStartup(StartupEventArgs e)
           {
               base.OnStartup(e);
   
               // Set the access token for ArcGIS Maps SDK for .NET.
               Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_ACCESS_TOKEN";
   
               // Call a function to set up the AuthenticationManager for OAuth.
               UserAuth.ArcGISLoginPrompt.SetChallengeHandler();
   
           }

3. ユーザー認証を設定するコードを削除します。

   App.xaml.cs

           protected override void OnStartup(StartupEventArgs e)
           {
               base.OnStartup(e);
   
               // Set the access token for ArcGIS Maps SDK for .NET.
               Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_ACCESS_TOKEN";
   
               // 削除開始
               // Call a function to set up the AuthenticationManager for OAuth.
               UserAuth.ArcGISLoginPrompt.SetChallengeHandler();
               // 削除終了
   
           }

1. Visual Studio のソリューション エクスプローラーから ArcGISLoginPrompt.cs ファイルを開きます。

2. クライアント ID (OAuthClientID) とリダイレクト URL (OAuthRedirectUri) の値を設定します。これらは認証の設定で作成したユーザー認証設定です。

   ArcGISLoginPrompt.cs

       internal static class ArcGISLoginPrompt
       {
           private const string ArcGISOnlineUrl = "https://www.arcgis.com/sharing/rest";
           // Specify the Client ID and Redirect URL to use with OAuth authentication.
           // See the instructions here for creating OAuth app settings:
           // https://developers.arcgis.com/documentation/security-and-authentication/user-authentication/tutorials/create-oauth-credentials-user-auth/
   
           private const string AppClientId = "YOUR_CLIENT_ID";
           private const string OAuthRedirectUrl = "YOUR_REDIRECT_URL";

3. Visual Studio のソリューション エクスプローラーで App.xaml.cs をクリックしてファイルを開きます。

4. API キーのアクセス トークンを設定するコード行を削除します。

   App.xaml.cs

           protected override void OnStartup(StartupEventArgs e)
           {
               base.OnStartup(e);
   
               // 削除開始
               // Set the access token for ArcGIS Maps SDK for .NET.
               Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_ACCESS_TOKEN";
               // 削除終了
   
               // Call a function to set up the AuthenticationManager for OAuth.
               UserAuth.ArcGISLoginPrompt.SetChallengeHandler();
   
           }