您可以將網頁式一般 OAuth 登入功能整合至應用程式,讓使用者透過 Yahoo 等 OAuth 供應商,使用 Firebase 進行驗證。請使用 Firebase SDK 執行端對端登入流程。由於這項流程需要使用手機版 Firebase SDK,因此僅支援 Android 和 Apple 平台。
事前準備
使用 Firebase Authentication 前,請先完成下列事項:
註冊 Unity 專案並設定使用 Firebase。
如果 Unity 專案已使用 Firebase,代表專案已註冊並設定 Firebase。
如果沒有 Unity 專案,可以下載範例應用程式。
將 Firebase Unity SDK (具體來說是
FirebaseAuth.unitypackage) 新增至 Unity 專案。
請注意,將 Firebase 新增至 Unity 專案時,您必須在 Firebase 控制台和開啟的 Unity 專案中執行工作 (例如從控制台下載 Firebase 設定檔,然後移至 Unity 專案)。
存取 Firebase.Auth.FirebaseAuth 類別
FirebaseAuth 類別是所有 API 呼叫的閘道。
可透過 FirebaseAuth.DefaultInstance 存取。Firebase.Auth.FirebaseAuth auth = Firebase.Auth.FirebaseAuth.DefaultInstance;
使用 Firebase SDK 處理登入流程
如要使用 Firebase SDK 處理登入流程,請按照下列步驟操作:
建構
FederatedOAuthProviderData執行個體,並設定 Yahoo 適用的供應商 ID。Firebase.Auth.FederatedOAuthProviderData providerData = new Firebase.Auth.FederatedOAuthProviderData(); providerData.ProviderId = Firebase.Auth.YahooAuthProvider.ProviderId;選用:指定要與 OAuth 要求一併傳送的其他自訂 OAuth 參數。
providerData.CustomParameters = new Dictionary<string,string>; // Prompt user to re-authenticate to Yahoo. providerData.CustomParameters.Add("prompt", "login"); // Localize to French. providerData.CustomParameters.Add("language", "fr");如要瞭解 Yahoo 支援的參數,請參閱 Yahoo OAuth 說明文件。請注意,您無法使用
custom_parameters()傳遞 Firebase 必要的參數。這些參數包括 client_id、redirect_uri、response_type、scope 和 state。選用:指定要向驗證服務供應商要求的其他 OAuth 2.0 範圍 (
profile和email以外)。如果應用程式需要透過 Yahoo API 存取私人使用者資料,您必須在 Yahoo 開發人員控制台的「API Permissions」下方,要求 Yahoo API 權限。要求的 OAuth 範圍必須與應用程式 API 權限中預先設定的範圍完全相符。舉例來說,如果要求使用者聯絡人的讀取/寫入權限,且已在應用程式的 API 權限中預先設定,則必須傳遞sdct-w,而非唯讀 OAuth 範圍sdct-r。否則流程會失敗,使用者也會看到錯誤訊息。providerData.Scopes = new List<string>(); // Request access to Yahoo Mail API. providerData.Scopes.Add("mail-r"); // This must be preconfigured in the app's API permissions. providerData.Scopes.Add("sdct-w");詳情請參閱 Yahoo 範圍說明文件。
設定供應商資料後,請使用該資料建立 FederatedOAuthProvider。
// Construct a FederatedOAuthProvider for use in Auth methods. Firebase.Auth.FederatedOAuthProvider provider = new Firebase.Auth.FederatedOAuthProvider(); provider.SetProviderData(providerData);使用驗證供應商物件向 Firebase 驗證。請注意,與其他 FirebaseAuth 作業不同,這項作業會彈出網頁檢視畫面,讓使用者輸入憑證,藉此控制使用者介面。
如要啟動登入流程,請呼叫
SignInAndRetrieveDataWithCredentialAsync:
<<../_includes/_sign_in_with_provider_unity.md>>>
雖然上述範例著重於登入流程,但您也可以使用
LinkWithProviderAsync將 Yahoo 供應商連結至現有使用者。舉例來說,您可以將多個供應商連結至同一位使用者,讓他們能使用任一供應商登入。user.LinkWithProviderAsync(provider).ContinueOnMainThread(task => { if (task.IsCanceled) { Debug.LogError("LinkWithProviderAsync was canceled."); return; } if (task.IsFaulted) { Debug.LogError("LinkWithProviderAsync encountered an error: " + task.Exception); return; } Firebase.Auth.AuthResult authResult = task.Result; Firebase.Auth.FirebaseUser user = authResult.User; Debug.LogFormat("User linked successfully: {0} ({1})", user.DisplayName, user.UserId); });ReauthenticateWithProviderAsync也可以使用相同的模式,擷取新的憑證,用於需要近期登入的機密作業。user.ReauthenticateWithProviderAsync(provider).ContinueOnMainThread(task => { if (task.IsCanceled) { Debug.LogError("ReauthenticateWithProviderAsync was canceled."); return; } if (task.IsFaulted) { Debug.LogError( "ReauthenticateWithProviderAsync encountered an error: " + task.Exception); return; } Firebase.Auth.AuthResult authResult = task.Result; Firebase.Auth.FirebaseUser user = authResult.User; Debug.LogFormat("User reauthenticated successfully: {0} ({1})", user.DisplayName, user.UserId); });
後續步驟
使用者首次登入後,系統會建立新的使用者帳戶,並連結至使用者登入時使用的憑證,也就是使用者名稱和密碼、電話號碼或驗證提供者資訊。這個新帳戶會儲存為 Firebase 專案的一部分,可用於識別專案中所有應用程式的使用者,無論使用者如何登入。
-
在應用程式中,您可以從
Firebase.Auth.FirebaseUser物件取得使用者的基本個人資料資訊:Firebase.Auth.FirebaseUser user = auth.CurrentUser; if (user != null) { string name = user.DisplayName; string email = user.Email; System.Uri photo_url = user.PhotoUrl; // The user's Id, unique to the Firebase project. // Do NOT use this value to authenticate with your backend server, if you // have one; use User.TokenAsync() instead. string uid = user.UserId; }
在 Firebase Realtime Database 和 Cloud Storage安全性規則中,您可以從
auth變數取得已登入使用者的專屬使用者 ID,並用來控管使用者可存取的資料。
您可以將驗證供應商憑證連結至現有使用者帳戶,允許使用者透過多個驗證供應商登入應用程式。
如要登出使用者,請呼叫 SignOut():
auth.SignOut();