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;

参数

范围类型描述
用户凭证用户凭证用户凭证。

返回:

验证凭证|无效的