您可以使用 Firebase SDK 將網頁式一般 OAuth 登入功能整合至應用程式,執行端對端登入流程,讓使用者透過 Microsoft Azure Active Directory 等 OAuth 供應商,使用 Firebase 進行驗證。
事前準備
如要讓使用者透過 Microsoft 帳戶 (Azure Active Directory 和個人 Microsoft 帳戶) 登入,您必須先在 Firebase 專案中啟用 Microsoft 做為登入服務供應商:
- 在 Firebase 控制台中,依序前往 「Security」(安全性) >「Authentication」(驗證)。
- 在「登入方式」分頁中,啟用「Microsoft」登入供應商。
-
將該供應商開發人員控制台中的「Client ID」(用戶端 ID) 和「Client Secret」(用戶端密鑰) 新增至供應商設定:
- 如要註冊 Microsoft OAuth 用戶端,請按照「快速入門導覽課程:使用 Azure Active Directory 2.0 版端點註冊應用程式」中的操作說明進行。請注意,這個端點支援使用 Microsoft 個人帳戶和 Azure Active Directory 帳戶登入。進一步瞭解 Azure Active Directory 2.0 版。
-
向這些供應商註冊應用程式時,請務必將專案的
*.firebaseapp.com網域註冊為應用程式的重新導向網域。
- 按一下「儲存」。
指定應用程式的 SHA-1 指紋 (如果尚未指定)。
在 Firebase 控制台中,依序前往「
Settings 」(設定) >「General」(一般) 分頁。向下捲動至「您的應用程式」資訊卡,選取 Android 應用程式,然後在「SHA 憑證指紋」欄位中新增 SHA-1 指紋。
如要瞭解如何取得應用程式的 SHA 指紋,請參閱「驗證用戶端」。
使用 Firebase SDK 處理登入流程
如果您正在建構 Android 應用程式,最簡單的方法是使用 Firebase Android SDK 處理整個登入流程,讓使用者透過 Microsoft 帳戶進行 Firebase 驗證。
如要使用 Firebase Android SDK 處理登入流程,請按照下列步驟操作:
使用 OAuthProvider 的建構工具,建構 OAuthProvider 的執行個體,並將 供應商 ID 設為 microsoft.com。
Kotlin
val provider = OAuthProvider.newBuilder("microsoft.com")
Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("microsoft.com");
選用:指定要與 OAuth 要求一併傳送的其他自訂 OAuth 參數。
Kotlin
// Target specific email with login hint. // Force re-consent. provider.addCustomParameter("prompt", "consent") // Target specific email with login hint. provider.addCustomParameter("login_hint", "user@firstadd.onmicrosoft.com")
Java
// Target specific email with login hint. // Force re-consent. provider.addCustomParameter("prompt", "consent"); // Target specific email with login hint. provider.addCustomParameter("login_hint", "user@firstadd.onmicrosoft.com");
如要瞭解 Microsoft 支援的參數,請參閱 Microsoft OAuth 說明文件。請注意,您無法使用
setCustomParameters()傳遞 Firebase 必要的參數。這些參數包括 client_id、response_type、redirect_uri、state、scope 和 response_mode。如要僅允許特定 Azure AD 租戶的使用者登入應用程式,可以使用 Azure AD 租戶的易記網域名稱或租戶的 GUID ID。方法是在自訂參數物件中指定「tenant」欄位。
Kotlin
// 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.addCustomParameter("tenant", "TENANT_ID")
Java
// 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.addCustomParameter("tenant", "TENANT_ID");
選用:指定要向驗證服務供應商要求的其他 OAuth 2.0 範圍 (基本設定檔除外)。
Kotlin
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. provider.scopes = listOf("mail.read", "calendars.read")
Java
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. List<String> scopes = new ArrayList<String>() { { add("mail.read"); add("calendars.read"); } }; provider.setScopes(scopes);
詳情請參閱 Microsoft 權限和同意聲明說明文件。
使用 OAuth 供應商物件向 Firebase 驗證。請注意,與其他 FirebaseAuth 作業不同,這項作業會彈出自訂 Chrome 分頁,接管 UI。因此,請勿在附加的
OnSuccessListener和OnFailureListener中參照 Activity,因為作業啟動 UI 時,這些項目會立即卸離。請先確認是否已收到回覆。透過這個方法登入會將活動置於背景,這表示系統可能會在登入流程中回收活動。為確保使用者在這種情況下不必重試,請檢查結果是否已存在。
如要檢查是否有待處理的結果,請呼叫
getPendingAuthResult:Kotlin
val pendingResultTask = firebaseAuth.pendingAuthResult if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. } } else { // There's no pending result so you need to start the sign-in flow. // See below. }
Java
Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult(); if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } }); } else { // There's no pending result so you need to start the sign-in flow. // See below. }
如要啟動登入流程,請呼叫
startActivityForSignInWithProvider:Kotlin
firebaseAuth .startActivityForSignInWithProvider(activity, provider.build()) .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. }
Java
firebaseAuth .startActivityForSignInWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
成功完成後,您可以從傳回的
OAuthCredential物件中,擷取與提供者相關聯的 OAuth 存取權杖。您可以使用 OAuth 存取權杖呼叫 Microsoft Graph API。
與 Firebase Auth 支援的其他供應商不同,Microsoft 不提供相片網址,而是必須透過 Microsoft Graph API 要求個人資料相片的二進位資料。
除了 OAuth 存取權杖外,您也可以從
OAuthCredential物件擷取使用者的 OAuth ID 權杖。ID 權杖中的sub宣告是應用程式專屬,不會與 Firebase Auth 使用的聯合使用者 ID 相符,且可透過user.getProviderData().get(0).getUid()存取。請改用oid宣告欄位。使用 Azure AD 租戶登入時,oid宣告會完全相符。不過,如果是非租戶,系統會填補oid欄位。如果是聯合 ID4b2eabcdefghijkl,oid的格式會是00000000-0000-0000-4b2e-abcdefghijkl。雖然上述範例著重於登入流程,但您也可以使用
startActivityForLinkWithProvider將 Microsoft 供應商連結至現有使用者。舉例來說,您可以將多個供應商連結至同一位使用者,讓他們能使用任一供應商登入。Kotlin
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForLinkWithProvider(activity, provider.build()) .addOnSuccessListener { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } .addOnFailureListener { // Handle failure. }
Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForLinkWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
startActivityForReauthenticateWithProvider也可以使用相同的模式,用於擷取需要近期登入的機密作業的新憑證。Kotlin
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForReauthenticateWithProvider(activity, provider.build()) .addOnSuccessListener { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } .addOnFailureListener { // Handle failure. }
Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
後續步驟
使用者首次登入後,系統會建立新的使用者帳戶,並連結至使用者登入時使用的憑證,也就是使用者名稱和密碼、電話號碼或驗證提供者資訊。這個新帳戶會儲存為 Firebase 專案的一部分,可用於識別專案中所有應用程式的使用者,無論使用者如何登入。
-
在應用程式中,您可以從
FirebaseUser物件取得使用者的基本個人資料。請參閱「管理使用者」。 在 Firebase Realtime Database 和 Cloud Storage安全性規則中,您可以從
auth變數取得已登入使用者的專屬使用者 ID,並用來控管使用者可存取的資料。
您可以將驗證供應商憑證連結至現有使用者帳戶,允許使用者透過多個驗證供應商登入應用程式。
如要登出使用者,請呼叫 signOut:
Kotlin
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();