您可以使用 Firebase SDK 將一般 OAuth 登入整合至您的應用程式,讓使用者透過 OAuth 供應商向 Firebase 進行驗證,藉此執行端對端登入流程。
事前準備
如要使用 Yahoo 帳戶登入使用者,您必須先啟用 Yahoo 做為 Firebase 專案的登入提供者:
- 將 Firebase 新增至 Apple 專案。
- 在 Firebase 控制台開啟「驗證」專區。
- 在「登入方式」分頁中,啟用 Yahoo 供應商。
- 從供應商的 Play 管理中心,新增「用戶端 ID」和「用戶端密鑰」到供應商設定:
-
如要註冊 Yahoo OAuth 用戶端,請按照 Yahoo 開發人員說明文件 向 Yahoo 註冊網頁應用程式中的指示操作。
請務必選取以下兩項 OpenID Connect API 權限:
profile
和email
。 - 向這些供應商註冊應用程式時,請務必為專案的
*.firebaseapp.com
網域註冊應用程式的重新導向網域。
-
- 按一下「儲存」。
使用 Firebase SDK 處理登入流程
如要使用 Firebase Apple 平台 SDK 處理登入流程,請按照下列步驟操作:
在 Xcode 專案中新增自訂網址配置:
使用提供者 ID yahoo.com 建立 OAuthProvider 的執行個體。
Swift
var provider = OAuthProvider(providerID: "yahoo.com")
Objective-C
FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"yahoo.com"];
選用:指定要與 OAuth 要求一起傳送的其他自訂 OAuth 參數。
Swift
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。選用:指定您想向驗證供應商要求的額外 OAuth 2.0 範圍 (超過
profile
和email
)。如果您的應用程式需要透過 Yahoo API 存取使用者私人資料,您就必須前往 Yahoo 開發人員主控台的 API 權限,向 Yahoo API 要求權限。要求的 OAuth 範圍必須與應用程式 API 權限中的預先設定範圍完全相符。舉例來說,如果向使用者聯絡人要求讀取/寫入權限,並在應用程式的 API 權限中預先設定,就必須傳遞sdct-w
,而非唯讀 OAuth 範圍sdct-r
。否則資料流會失敗,且使用者會看到錯誤訊息。Swift
// 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 進行驗證。
Swift
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
是可從Auth.auth.currentUser.providerData[0].uid
欄位或authResult.additionalUserInfo.profile
擷取的 Yahoo 使用者 ID。雖然上述範例著重於登入流程,但您也可以使用
linkWithPopup
將 Yahoo 供應商連結至現有使用者。例如,您可以將多個提供者連結至同一位使用者,讓對方透過任一提供者登入。Swift
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
搭配使用,針對需要近期登入的敏感作業擷取最新憑證。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 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 即時資料庫和 Cloud 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; }
您可能也想要針對各種驗證錯誤加入錯誤處理程式碼。請參閱處理錯誤。