在 Apple 平台上使用 Microsoft 進行驗證

您可以透過 Firebase 驗證使用者,方法是使用 Firebase SDK 將網頁型一般 OAuth 登入服務整合至應用程式,藉此執行端對端登入流程,並使用 Microsoft Azure Active Directory 等 OAuth 提供者。

事前準備

如要使用 Microsoft 帳戶 (Azure Active Directory 和個人 Microsoft 帳戶) 登入使用者,請先為 Firebase 專案啟用 Microsoft 做為登入供應商:

  1. 將 Firebase 新增至 Apple 專案
  2. Firebase 控制台中,依序前往「安全性」>「驗證」
  3. 在「登入方式」分頁中,啟用「Microsoft」登入資訊提供者。
  4. 將該供應商開發人員控制台的「用戶端 ID」和「用戶端密鑰」新增至供應商設定:
    1. 如要註冊 Microsoft OAuth 用戶端,請按照「快速入門:使用 Azure Active Directory v2.0 端點註冊應用程式」中的操作說明進行。 請注意,這個端點支援使用 Microsoft 個人帳戶和 Azure Active Directory 帳戶登入。進一步瞭解 Azure Active Directory v2.0
    2. 向這些供應商註冊應用程式時,請務必將專案的 *.firebaseapp.com 網域註冊為應用程式的重新導向網域。
  5. 按一下「儲存」

使用 Firebase SDK 處理登入流程

如要使用 Firebase Apple 平台 SDK 處理登入流程,請按照下列步驟操作:

  1. 在 Xcode 專案中新增自訂網址架構:

    1. 開啟專案設定:在左側樹狀檢視中按兩下專案名稱。在「目標」部分選取您的應用程式,然後選取「資訊」分頁標籤,並展開「網址類型」部分。
    2. 按一下 + 按鈕,然後將編碼後的應用程式 ID 新增為網址配置。將其他欄位留空。

      您可以在 Firebase 控制台中找到編碼後的應用程式 ID:依序前往「設定」 >「一般」分頁標籤,然後向下捲動至「您的應用程式」部分,即可查看 iOS 應用程式的詳細資料。

      完成後,您的設定應如下所示 (但會使用應用程式專屬值):

      Xcode 的自訂網址配置設定介面螢幕截圖
  2. 使用提供者 ID microsoft.com 建立 OAuthProvider 的執行個體。

    Swift

        var provider = OAuthProvider(providerID: "microsoft.com")
        

    Objective-C

        FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"microsoft.com"];
        
  3. 選用:指定要隨 OAuth 要求傳送的其他自訂 OAuth 參數。

    Swift

        provider.customParameters = [
          "prompt": "consent",
          "login_hint": "user@firstadd.onmicrosoft.com"
        ]
        

    Objective-C

        [provider setCustomParameters:@{@"prompt": @"consent", @"login_hint": @"user@firstadd.onmicrosoft.com"}];
        

    如要瞭解 Microsoft 支援的參數,請參閱 Microsoft OAuth 說明文件。請注意,您無法使用 setCustomParameters 傳遞 Firebase 必要參數。這些參數包括 client_idresponse_typeredirect_uristatescoperesponse_mode

    如要只允許特定 Azure AD 租戶的使用者登入應用程式,可以使用 Azure AD 租戶的易記網域名稱或租戶的 GUID ID。如要執行這項操作,請在自訂參數物件中指定「tenant」欄位。

    Swift

        provider.customParameters = [
          // Optional "tenant" parameter in case you are using an Azure AD
          // tenant. eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or
          // 'contoso.onmicrosoft.com' or "common" for tenant-independent
          // tokens. The default value is "common".
          "tenant": "TENANT_ID"
        ]
        

    Objective-C

        // Optional "tenant" parameter in case you are using an Azure AD tenant.
        // eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or
        // 'contoso.onmicrosoft.com' or "common" for tenant-independent tokens.
        // The default value is "common".
        provider.customParameters = @{@"tenant": @"TENANT_ID"};
        
  4. 選用:指定基本設定檔以外的其他 OAuth 2.0 範圍,以便向驗證供應商要求。

    Swift

        provider.scopes = ["mail.read", "calendars.read"]
        

    Objective-C

        [provider setScopes:@[@"mail.read", @"calendars.read"]];
        

    詳情請參閱 Microsoft 權限和同意聲明說明文件

  5. 選用:如要自訂應用程式向使用者顯示 reCAPTCHA 時呈現 SFSafariViewControllerUIWebView 的方式,請建立符合 AuthUIDelegate 通訊協定的自訂類別,並將其傳遞至 credentialWithUIDelegate

  6. 使用 OAuth 供應商物件向 Firebase 進行驗證。

    Swift

        // Replace nil with the custom class that conforms to AuthUIDelegate
        // you created in last step to use a customized web view.
        provider.getCredentialWith(nil) { credential, error in
          if error != nil {
            // Handle error.
          }
          if credential != nil {
            Auth().signIn(with: credential) { authResult, error in
              if error != nil {
                // Handle error.
              }
              // User is signed in.
              // IdP data available in authResult.additionalUserInfo.profile.
              // OAuth access token can also be retrieved:
              // (authResult.credential as? OAuthCredential)?.accessToken
              // OAuth ID token can also be retrieved:
              // (authResult.credential as? OAuthCredential)?.idToken
            }
          }
        }
        

    Objective-C

        [provider getCredentialWithUIDelegate:nil
                                   completion:^(FIRAuthCredential *_Nullable credential, NSError *_Nullable error) {
          if (error) {
           // Handle error.
          }
          if (credential) {
            [[FIRAuth auth] signInWithCredential:credential
                                      completion:^(FIRAuthDataResult *_Nullable authResult, NSError *_Nullable error) {
              if (error) {
                // Handle error.
              }
              // User is signed in.
              // IdP data available in authResult.additionalUserInfo.profile.
              // OAuth access token can also be retrieved:
              // ((FIROAuthCredential *)authResult.credential).accessToken
              // OAuth ID token can also be retrieved:
              // ((FIROAuthCredential *)authResult.credential).idToken
            }];
          }
        }];
        

    您可以使用 OAuth 存取權杖呼叫 Microsoft Graph API

    舉例來說,如要取得基本個人資料資訊,您可以呼叫 REST API,並在 Authorization 標頭中傳遞存取權杖:

    https://graph.microsoft.com/v1.0/me

    與 Firebase Auth 支援的其他供應商不同,Microsoft 不會提供相片網址,而是必須透過 Microsoft Graph API 要求個人資料相片的二進位資料。

    除了 OAuth 存取權杖,使用者的 OAuth ID 權杖也可以從 OAuthCredential 物件中擷取。ID 權杖中的 sub 聲明是應用程式專屬,不會與 Firebase Auth 使用的聯合使用者 ID 相符,且無法透過 user.providerData[0].uid 存取。請改用 oid 聲明欄位。使用 Azure AD 租戶登入時,oid 權杖附加資訊會完全相符。不過,如果不是租戶案例,oid 欄位會經過填補。如果是同盟 ID 4b2eabcdefghijkl,則 oid 的形式為 00000000-0000-0000-4b2e-abcdefghijkl

  7. 雖然上述範例著重於登入流程,但您也可以使用 linkWithCredential,將 Microsoft 供應商連結至現有使用者。舉例來說,您可以將多個供應商連結至同一位使用者,讓使用者透過任一供應商登入。

    Swift

        Auth().currentUser.link(withCredential: credential) { authResult, error in
          if error != nil {
            // Handle error.
          }
          // Microsoft credential is linked to the current user.
          // IdP data available in authResult.additionalUserInfo.profile.
          // OAuth access token can also be retrieved:
          // (authResult.credential as? OAuthCredential)?.accessToken
          // OAuth ID token can also be retrieved:
          // (authResult.credential as? OAuthCredential)?.idToken
        }
        

    Objective-C

        [[FIRAuth auth].currentUser
            linkWithCredential:credential
                    completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
          if (error) {
            // Handle error.
          }
          // Microsoft credential is linked to the current user.
          // IdP data available in authResult.additionalUserInfo.profile.
          // OAuth access token can also be retrieved:
          // ((FIROAuthCredential *)authResult.credential).accessToken
          // OAuth ID token can also be retrieved:
          // ((FIROAuthCredential *)authResult.credential).idToken
        }];
        
  8. 您可以使用相同的模式搭配 reauthenticateWithCredential,為需要最近登入的敏感作業擷取最新憑證。

    Swift

        Auth().currentUser.reauthenticateWithCredential(withCredential: credential) { authResult, error in
          if error != nil {
            // Handle error.
          }
          // User is re-authenticated with fresh tokens minted and
          // should be able to perform sensitive operations like account
          // deletion and email or password update.
          // IdP data available in result.additionalUserInfo.profile.
          // Additional OAuth access token can also be retrieved:
          // (authResult.credential as? OAuthCredential)?.accessToken
          // OAuth ID token can also be retrieved:
          // (authResult.credential as? OAuthCredential)?.idToken
        }
        

    Objective-C

        [[FIRAuth auth].currentUser
            reauthenticateWithCredential:credential
                              completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
          if (error) {
            // Handle error.
          }
          // User is re-authenticated with fresh tokens minted and
          // should be able to perform sensitive operations like account
          // deletion and email or password update.
          // IdP data available in result.additionalUserInfo.profile.
          // Additional OAuth access token can also be retrieved:
          // ((FIROAuthCredential *)authResult.credential).accessToken
          // OAuth ID token can also be retrieved:
          // ((FIROAuthCredential *)authResult.credential).idToken
        }];
        

使用者首次登入後,系統會建立新的使用者帳戶,並連結至使用者登入時使用的憑證 (即使用者名稱和密碼、電話號碼或驗證供應商資訊)。這個新帳戶會儲存在 Firebase 專案中,可用於識別專案中每個應用程式的使用者,無論使用者登入方式為何。

  • 在應用程式中,您可以從 User 物件取得使用者的基本個人資料資訊。請參閱「管理使用者」。

  • Firebase Realtime DatabaseCloud Storage 安全規則中,您可以從 auth 變數取得已登入使用者的專屬使用者 ID, 並使用該 ID 控制使用者可存取的資料。

您可以將驗證供應商憑證連結至現有使用者帳戶,允許使用者透過多個驗證供應商登入應用程式。

如要登出使用者,請呼叫 signOut:

Swift

let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print("Error signing out: %@", signOutError)
}

Objective-C

NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

您也可以新增錯誤處理程式碼,處理各種驗證錯誤。請參閱「處理錯誤」。