SAMLAuthProvider class

SAML 的 AuthProvider。

簽名：

export declare class SAMLAuthProvider extends FederatedAuthProvider 

擴充：FederatedAuthProvider

建構函式

建構函式	修飾符	說明
(建構函式)(providerId)		建構函式。providerId 必須以「saml」開頭。

方法

方法	修飾符	說明
credentialFromError(錯誤)	static	用於從登入、連結或重新驗證作業期間擲回的 AuthError 中，擷取基礎 OAuthCredential。
credentialFromJSON(json)	static	透過 JSON 字串或純物件建立 AuthCredential。
credentialFromResult(使用者憑證)	static	成功完成 SAML 流程後，透過 UserCredential 產生 AuthCredential。

SAMLAuthProvider.(建構函式)

建構函式。providerId 必須以「saml」開頭。

簽名：

constructor(providerId: string);

參數

參數	類型	說明
供應商 ID	字串	SAML 提供者 ID。

SAMLAuthProvider.credentialFromError()

用於從登入、連結或重新驗證作業期間擲回的 AuthError 中，擷取基礎 OAuthCredential。

簽名：

static credentialFromError(error: FirebaseError): AuthCredential | null;

參數

參數	類型	說明
錯誤	FirebaseError

傳回：

AuthCredential |空值

SAMLAuthProvider.credentialFromJSON()

透過 JSON 字串或純物件建立 AuthCredential。

簽名：

static credentialFromJSON(json: string | object): AuthCredential;

參數

參數	類型	說明
json	字串 |物體	純物件或 JSON 字串

傳回：

AuthCredential

SAMLAuthProvider.credentialFromResult()

成功完成 SAML 流程後，透過 UserCredential 產生 AuthCredential。

舉例來說，如要取得 AuthCredential，您可以編寫以下程式碼：

const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);

簽名：

static credentialFromResult(userCredential: UserCredential): AuthCredential | null;

參數

參數	類型	說明
使用者憑證	使用者憑證	使用者憑證。

傳回：

AuthCredential |空值