您可以使用 Firebase SDK 將通用 OAuth 登入整合到您的應用程式中,以執行端對端登入流程,讓您的使用者使用 Yahoo 等 OAuth 提供者透過 Firebase 進行身份驗證。
在你開始之前
若要使用 Yahoo 帳戶登入用戶,您必須先啟用 Yahoo 作為 Firebase 專案的登入提供者:
- 將 Firebase 新增到您的 Apple 專案。
- 在Firebase 控制台中,開啟「驗證」部分。
- 在「登入方法」標籤上,啟用Yahoo提供者。
- 將客戶端 ID和客戶端金鑰從該提供者的開發人員控制台新增至提供者設定:
要註冊 Yahoo OAuth 用戶端,請遵循有關向 Yahoo 註冊 Web 應用程式的Yahoo 開發人員文件。
請務必選擇兩個 OpenID Connect API 權限:
profile
和email
。- 向這些提供者註冊應用程式時,請務必將專案的
*.firebaseapp.com
網域註冊為應用程式的重新導向網域。
- 按一下「儲存」 。
使用 Firebase SDK 處理登入流程
若要使用 Firebase Apple 平台 SDK 處理登入流程,請依照下列步驟操作:
將自訂 URL 方案新增至您的 Xcode 專案:
- 開啟專案配置:雙擊左側樹視圖中的專案名稱。從“目標”部分選擇您的應用程序,然後選擇“資訊”選項卡,並展開“URL 類型”部分。
- 點擊+按鈕,並將您的編碼應用程式 ID 新增為 URL 方案。您可以在 Firebase 控制台的「常規設定」頁面上的 iOS 應用程式部分中找到您的編碼應用程式 ID。將其他欄位留空。
完成後,您的配置應類似於以下內容(但具有特定於應用程式的值):
使用提供者 ID yahoo.com建立OAuthProvider的實例。
迅速
var provider = OAuthProvider(providerID: "yahoo.com")
Objective-C
FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"yahoo.com"];
可選:指定要與 OAuth 請求一起傳送的其他自訂 OAuth 參數。
迅速
provider.customParameters = [ "prompt": "login", "language": "fr" ]
Objective-C
[provider setCustomParameters:@{@"prompt": @"login", @"language": @"fr"}];
有關 Yahoo 支援的參數,請參閱Yahoo OAuth 文件。請注意,您無法使用
setCustomParameters
傳遞 Firebase 所需的參數。這些參數是client_id 、 redirect_uri 、 response_type 、 scope和state 。可選:指定您想要從身分驗證提供者要求的
profile
和email
以外的其他 OAuth 2.0 範圍。如果您的應用程式需要從 Yahoo API 存取私人使用者數據,您需要在 Yahoo 開發者控制台的API 權限下請求對 Yahoo API 的權限。請求的 OAuth 範圍必須與應用程式 API 權限中預先配置的範圍完全相符。例如,如果向使用者聯絡人請求讀取/寫入存取權限並在應用程式的 API 權限中預先配置,則必須傳遞sdct-w
而不是只讀 OAuth 範圍sdct-r
。否則,流程將失敗並向最終使用者顯示錯誤。迅速
// Request access to Yahoo Mail API. // Request read/write access to user contacts. // This must be preconfigured in the app's API permissions. provider.scopes = ["mail-r", "sdct-w"]
Objective-C
// Request access to Yahoo Mail API. // Request read/write access to user contacts. // This must be preconfigured in the app's API permissions. [provider setScopes:@[@"mail-r", @"sdct-w"]];
要了解更多信息,請參閱Yahoo 範圍文件。
可選:如果要自訂應用程式在向使用者顯示 reCAPTCHA 時呈現
SFSafariViewController
或UIWebView
的方式,請建立符合AuthUIDelegate
協定的自訂類,並將其傳遞給credentialWithUIDelegate
。使用 OAuth 提供者物件透過 Firebase 進行身份驗證。
迅速
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. // Yahoo OAuth access token can also be retrieved by: // (authResult.credential as? OAuthCredential)?.accessToken // Yahoo OAuth ID token can be retrieved by calling: // (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. // Yahoo OAuth access token can also be retrieved by: // ((FIROAuthCredential *)authResult.credential).accessToken // Yahoo OAuth ID token can be retrieved by calling: // ((FIROAuthCredential *)authResult.credential).idToken }]; } }];
使用 OAuth 存取令牌,您可以呼叫Yahoo API 。
例如,要取得基本設定檔訊息,您可以呼叫 REST API,在
Authorization
標頭中傳遞存取權杖:https://social.yahooapis.com/v1/user/YAHOO_USER_UID/profile?format=json
其中
YAHOO_USER_UID
是 Yahoo 使用者的 ID,可以從Auth.auth.currentUser.providerData[0].uid
欄位或authResult.additionalUserInfo.profile
檢索。雖然上面的範例重點關注登入流程,但您也可以使用
linkWithPopup
將 Yahoo 提供者連結到現有使用者。例如,您可以將多個提供者連結到同一用戶,允許他們使用其中任一提供者登入。迅速
Auth().currentUser.link(withCredential: credential) { authResult, error in if error != nil { // Handle error. } // Yahoo credential is linked to the current user. // IdP data available in authResult.additionalUserInfo.profile. // Yahoo OAuth access token can also be retrieved by: // (authResult.credential as? OAuthCredential)?.accessToken // Yahoo OAuth ID token can be retrieved by calling: // (authResult.credential as? OAuthCredential)?.idToken }
Objective-C
[[FIRAuth auth].currentUser linkWithCredential:credential completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) { if (error) { // Handle error. } // Yahoo credential is linked to the current user. // IdP data available in authResult.additionalUserInfo.profile. // Yahoo OAuth access token is can also be retrieved by: // ((FIROAuthCredential *)authResult.credential).accessToken // Yahoo OAuth ID token can be retrieved by calling: // ((FIROAuthCredential *)authResult.credential).idToken }];
相同的模式可以與
reauthenticateWithPopup
/reauthenticateWithRedirect
一起使用,它可用於檢索需要最近登入的敏感操作的新憑證。迅速
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 is can also be retrieved by: // (authResult.credential as? OAuthCredential)?.accessToken // Yahoo OAuth ID token can be retrieved by calling: // (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 is can also be retrieved by: // ((FIROAuthCredential *)authResult.credential).accessToken // Yahoo OAuth ID token can be retrieved by calling: // ((FIROAuthCredential *)authResult.credential).idToken }];
下一步
使用者首次登入後,系統會建立新的使用者帳戶,並將其連結到使用者登入時所使用的憑證(即使用者名稱和密碼、電話號碼或驗證提供者資訊)。此新帳戶將作為 Firebase 專案的一部分存儲,並且可用於識別專案中每個應用程式中的用戶,無論用戶如何登入。
在 Firebase 即時資料庫和雲端儲存安全性規則中,您可以從
auth
變數取得登入使用者的唯一使用者 ID,並使用它來控制使用者可以存取哪些資料。
您可以透過將身分驗證提供者憑證連結到現有使用者帳戶,允許使用者使用多個驗證提供者登入您的應用程式。
若要登出用戶,請呼叫signOut:
迅速
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; }
您可能還需要為所有身份驗證錯誤新增錯誤處理代碼。請參閱處理錯誤。