SAMLAuthProvider class

SAML 的 AuthProvider。

签名：

export declare class SAMLAuthProvider extends FederatedAuthProvider 

扩展：FederatedAuthProvider

构造函数

构造函数	修饰符	说明
(构造函数)(providerId)		构造函数。providerId 必须以“saml”开头。

方法

方法	修饰符	说明
credentialFromError(error)	static	用于从登录、关联或重新进行身份验证操作期间抛出的 AuthError 中提取底层 OAuthCredential。
credentialFromJSON(json)	static	从 JSON 字符串或普通对象创建 AuthCredential。
credentialFromResult(userCredential)	static	在 SAML 流程成功后根据 UserCredential 生成 AuthCredential。

SAMLAuthProvider.（构造函数）

构造函数。providerId 必须以“saml”开头。

签名：

constructor(providerId: string);

参数

参数	类型	说明
providerId	字符串	SAML 提供方 ID。

SAMLAuthProvider.credentialFromError()

用于从登录、关联或重新进行身份验证操作期间抛出的 AuthError 中提取底层 OAuthCredential。

签名：

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

参数

参数	类型	说明
error	FirebaseError

返回：

AuthCredential |null

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;

参数

参数	类型	说明
userCredential	UserCredential	用户凭据。

返回：

AuthCredential |null