您可以透過 Firebase 驗證功能,讓使用者使用 Yahoo 等 OAuth 提供者進行驗證。方法是使用 Firebase SDK,在應用程式中整合以網頁為基礎的一般 OAuth 登入功能,執行端對端登入流程。
事前準備
如要使用 Yahoo 帳戶登入使用者,請先為 Firebase 專案啟用 Yahoo 做為登入供應商:
- 在 Firebase 控制台中,開啟「Auth」(驗證) 專區。
- 在「登入方式」分頁中,啟用「Yahoo」供應器。
- 將該供應商開發人員控制台的「用戶端 ID」和「用戶端密鑰」新增至供應商設定:
-
如要註冊 Yahoo OAuth 用戶端,請參閱 Yahoo 開發人員說明文件,瞭解如何 向 Yahoo 註冊網路應用程式。
請務必選取下列兩項 OpenID Connect API 權限:
profile和email。 - 向這些供應商註冊應用程式時,請務必將專案的
*.firebaseapp.com網域註冊為應用程式的重新導向網域。
-
- 按一下 [儲存]。
如果尚未指定應用程式的 SHA-1 指紋,請前往 Firebase 控制台的「設定」頁面進行設定。如要瞭解如何取得應用程式的 SHA-1 指紋,請參閱「驗證用戶端」一文。
使用 Firebase SDK 處理登入流程
如果您要建構 Android 應用程式,最簡單的方法是使用 Firebase Android SDK 處理整個登入流程,讓使用者透過 Yahoo 帳戶驗證身分。
如要使用 Firebase Android SDK 處理登入流程,請按照下列步驟操作:
使用 Builder 建立 OAuthProvider 的執行個體,並使用提供者 ID yahoo.com。
Kotlin
val provider = OAuthProvider.newBuilder("yahoo.com")
Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("yahoo.com");
選用:指定要隨 OAuth 要求傳送的其他自訂 OAuth 參數。
Kotlin
// Prompt user to re-authenticate to Yahoo. provider.addCustomParameter("prompt", "login") // Localize to French. provider.addCustomParameter("language", "fr")
Java
// Prompt user to re-authenticate to Yahoo. provider.addCustomParameter("prompt", "login"); // Localize to French. provider.addCustomParameter("language", "fr");
如要瞭解 Yahoo 支援的參數,請參閱 Yahoo OAuth 說明文件。請注意,您無法使用
setCustomParameters()傳遞 Firebase 必要參數。這些參數包括 client_id、redirect_uri、response_type、scope 和 state。選用:指定要向驗證供應商要求的
profile和email以外的其他 OAuth 2.0 範圍。如果您的應用程式需要存取 Yahoo API 的私人使用者資料,請在 Yahoo 開發人員控制台的「API Permissions」(API 權限) 下方,要求 Yahoo API 的權限。要求的 OAuth 範圍必須與應用程式 API 權限中預先設定的範圍完全相符。舉例來說,如果要求讀取/寫入使用者聯絡人資料的權限,且已在應用程式的 API 權限中預先設定,則必須傳遞sdct-w,而非唯讀 OAuth 範圍sdct-r。否則流程會失敗,且系統會向使用者顯示錯誤訊息。Kotlin
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. provider.scopes = listOf("mail-r", "sdct-w")
Java
詳情請參閱 Yahoo 範圍說明文件。// 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>() { { // Request access to Yahoo Mail API. add("mail-r"); // This must be preconfigured in the app's API permissions. add("sdct-w"); } }; provider.setScopes(scopes);
使用 OAuth 供應商物件向 Firebase 進行驗證。請注意,與其他 FirebaseAuth 作業不同,這項作業會彈出 Chrome 自訂分頁,藉此控管 UI。因此,請勿在您附加的 OnSuccessListeners 和 OnFailureListeners 中參照 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 存取權杖呼叫 Yahoo API。
其中
YAHOO_USER_UID是 Yahoo 使用者 ID,可從firebaseAuth.getCurrentUser().getProviderData().get(0).getUid()欄位或authResult.getAdditionalUserInfo().getProfile()剖析。雖然上述範例著重於登入流程,但您也可以使用
startActivityForLinkWithProvider,將 Yahoo 供應商連結至現有使用者。舉例來說,您可以將多個供應商連結至同一位使用者,讓使用者透過任一供應商登入。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, 並使用該 ID 控制使用者可存取的資料。
您可以將驗證供應商憑證連結至現有使用者帳戶,允許使用者透過多個驗證供應商登入應用程式。
如要登出使用者,請呼叫
signOut:
Kotlin
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();