SAMLAuthProvider class

SAML 的AuthProvider

簽名:

export declare class SAMLAuthProvider extends FederatedAuthProvider 

擴展: FederatedAuthProvider

建構函數

建構函數修飾符描述
(建構子)(providerId)構造函數。 providerId 必須以「saml」開頭。

方法

方法修飾符描述
憑證來自錯誤(錯誤) static用於從登入、連結或重新驗證作業期間引發的AuthError中提取基礎OAuthCredential
憑證來自JSON(json) static從 JSON 字串或普通物件建立AuthCredential
憑證來自結果(使用者憑證) static在 SAML 流程成功完成後,從UserCredential產生AuthCredential

SAMLAuthProvider。(建構函式)

構造函數。 providerId 必須以「saml」開頭。

簽名:

constructor(providerId: string);

參數

範圍類型描述
提供者ID細繩SAML 提供者 ID。

SAMLAuthProvider.credentialFromError()

用於從登入、連結或重新驗證作業期間引發的AuthError中提取基礎OAuthCredential

簽名:

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

參數

範圍類型描述
錯誤Firebase錯誤

返回:

驗證憑證|無效的

SAMLAuthProvider.credentialFromJSON()

從 JSON 字串或普通物件建立AuthCredential

簽名:

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

參數

範圍類型描述
json字串 |目的普通物件或 JSON 字串

返回:

驗證憑證

SAMLAuthProvider.credentialFromResult()

在 SAML 流程成功完成後,從UserCredential產生AuthCredential

例如,取得AuthCredential ,您可以編寫以下程式碼:

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

簽名:

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

參數

範圍類型描述
使用者憑證使用者憑證用戶憑證。

返回:

驗證憑證|無效的