快速入門:從iOS或macOS應用程式登入使用者並呼叫 Microsoft Graph API

歡迎! 這可能不是您預期的頁面。 當我們處理修正時,此鏈接應該會帶您前往正確的文章:

快速入門:從iOS或macOS應用程式登入使用者並呼叫 Microsoft Graph

我們為不便道歉,並感謝您的耐心,同時我們努力解決這個問題。

在本快速入門中,您會下載並執行程式碼範例,示範原生 iOS 或 macOS 應用程式如何登入使用者,並取得存取令牌來呼叫 Microsoft Graph API。

本快速入門同時適用於 iOS 和 macOS 應用程式。 某些步驟僅適用於 iOS 應用程式,因此會以此類方式指出。

必要條件

  • 具有有效訂用帳戶的 Azure 帳戶。 免費建立帳戶
  • XCode 10+
  • iOS 10+
  • macOS 10.12+

範例的運作方式

顯示本快速入門所產生的範例應用程式運作方式

步驟 1:設定您的應用程式

若要讓本快速入門的程式代碼範例能夠運作,請新增 與 Auth Broker 相容的重新導向 URI

已設定 您的應用程式已使用這些屬性進行設定

步驟 2:下載範例專案

步驟 3:安裝相依性

  1. 解壓縮檔案。
  2. 在終端機視窗中,流覽至具有已下載程式碼範例的資料夾,然後執行 pod install 以安裝最新的 MSAL 連結庫。

步驟 4:您的應用程式已設定並準備好執行

我們已使用您應用程式屬性的值來設定您的專案,且已準備好執行。

注意

Enter_the_Supported_Account_Info_Here

  1. 如果您要建置 Microsoft Entra 國家雲端的應用程式,請將開頭為 'let kGraphEndpoint' 和 'let kAuthority' 的行取代為正確的端點。 針對全域存取,請使用預設值:

    let kGraphEndpoint = "https://graph.microsoft.com/"
    let kAuthority = "https://login.microsoftonline.com/common"
    
  2. 這裏記載了其他端點。 例如,若要使用 Microsoft Entra Germany 執行快速入門,請使用下列專案:

    let kGraphEndpoint = "https://graph.microsoft.de/"
    let kAuthority = "https://login.microsoftonline.de/common"
    
  3. 開啟項目設定。 在 [ 身分 識別] 區段中,輸入 您在入口網站中輸入的套件組合標識符

  4. 以滑鼠右鍵按兩下 [Info.plist],然後選取 [開放為>原始程式碼]。

  5. 在聽寫根節點底下,將 取代Enter_the_bundle_Id_Here為您在入口網站中使用的套件組合標識碼。 msauth.請注意字串中的前置詞。

    <key>CFBundleURLTypes</key>
    <array>
       <dict>
          <key>CFBundleURLSchemes</key>
          <array>
             <string>msauth.Enter_the_Bundle_Id_Here</string>
          </array>
       </dict>
    </array>
    
  6. 建置並執行應用程式!

相關資訊

請閱讀這些章節,以深入瞭解本快速入門。

取得 MSAL

MSAL (MSAL.framework) 是用來登入使用者和要求令牌的連結庫,用來存取受 Microsoft 身分識別平台 保護的 API。 您可以使用下列程式將 MSAL 新增至應用程式:

$ vi Podfile

將下列內容新增至此 Podfile(您的項目目標):

use_frameworks!

target 'MSALiOS' do
   pod 'MSAL'
end

執行 CocoaPods 安裝命令:

pod install

初始化 MSAL

您可以藉由新增下列程式代碼來新增 MSAL 的參考:

import MSAL

然後,使用下列程式代碼初始化 MSAL:

let authority = try MSALAADAuthority(url: URL(string: kAuthority)!)

let msalConfiguration = MSALPublicClientApplicationConfig(clientId: kClientID, redirectUri: nil, authority: authority)
self.applicationContext = try MSALPublicClientApplication(configuration: msalConfiguration)
其中: 描述
clientId portal.azure.com 中 註冊的應用程式的應用程式標識碼
authority Microsoft 身分識別平台。 在大部分情況下,這會是 https://login.microsoftonline.com/common>
redirectUri 應用程式的重新導向 URI。 您可以傳遞 『nil』 以使用預設值,或自定義重新導向 URI。

僅限 iOS,其他應用程式需求

您的應用程式也必須在 中 AppDelegate具有下列專案。 這可讓 MSAL SDK 在您進行驗證時處理來自 Auth Broker 應用程式的令牌回應。

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {

    return MSALPublicClientApplication.handleMSALResponse(url, sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String)
}

注意

在 iOS 13+ 上,如果您採用 UISceneDelegate 而非 ,請將此程式代碼改為放入scene:openURLContexts:回呼中(請參閱 Apple 的檔案UIApplicationDelegate)。 如果您支援UISceneDelegate和UIApplicationDelegate以與舊版iOS相容,MSAL回呼必須放在這兩個地方。

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {

   guard let urlContext = URLContexts.first else {
      return
   }

   let url = urlContext.url
   let sourceApp = urlContext.options.sourceApplication

   MSALPublicClientApplication.handleMSALResponse(url, sourceApplication: sourceApp)
}

最後,您的應用程式必須有 LSApplicationQueriesSchemes Info.plist 中的專案,以及 CFBundleURLTypes。 此範例隨附於此範例中。

<key>LSApplicationQueriesSchemes</key>
<array>
   <string>msauthv2</string>
   <string>msauthv3</string>
</array>

登入使用者和要求令牌

MSAL 有兩種方法可用來取得令牌: acquireTokenacquireTokenSilent

acquireToken:以互動方式取得令牌

在某些情況下,用戶必須與 Microsoft 身分識別平台 互動。 在這些情況下,使用者可能需要選取其帳戶、輸入其認證或同意您應用程式的許可權。 例如,

  • 使用者第一次登入應用程式時
  • 如果使用者重設其密碼,則必須輸入其認證
  • 當您的應用程式第一次要求存取資源時
  • 需要 MFA 或其他條件式存取原則時
let parameters = MSALInteractiveTokenParameters(scopes: kScopes, webviewParameters: self.webViewParamaters!)
self.applicationContext!.acquireToken(with: parameters) { (result, error) in /* Add your handling logic */}
其中: 描述
scopes 包含所要求的範圍(也就是 [ "user.read" ] Microsoft Graph 或 [ "<Application ID URL>/scope" ] 自定義 Web API (api://<Application ID>/access_as_user))

acquireTokenSilent:以無訊息方式取得存取令牌

每次要求令牌時,應用程式不應該要求其使用者登入。 如果用戶已經登入,這個方法可讓應用程式以無訊息方式要求令牌。

self.applicationContext!.getCurrentAccount(with: nil) { (currentAccount, previousAccount, error) in

   guard let account = currentAccount else {
      return
   }

   let silentParams = MSALSilentTokenParameters(scopes: self.kScopes, account: account)
   self.applicationContext!.acquireTokenSilent(with: silentParams) { (result, error) in /* Add your handling logic */}
}
其中: 描述
scopes 包含所要求的範圍(也就是 [ "user.read" ] Microsoft Graph 或 [ "<Application ID URL>/scope" ] 自訂 Web API 的範圍 (api://<Application ID>/access_as_user
account 要求令牌的帳戶。 本快速入門是關於單一帳戶應用程式。 如果您想要建置多帳戶應用程式,您必須定義邏輯,以識別要使用哪一個帳戶進行令牌要求 accountsFromDeviceForParameters:completionBlock: ,並傳遞正確的帳戶 accountIdentifier

說明與支援 

如果您需要協助、想要回報問題,或想要了解支援選項,請參閱 開發人員的說明和支援。

下一步

移至您建置 iOS 或 macOS 應用程式的逐步教學課程,以從 Microsoft 身分識別平台 取得存取令牌,並使用它來呼叫 Microsoft Graph API。