SAMLAuthProvider class

SAML 用のAuthProvider

サイン:

export declare class SAMLAuthProvider extends FederatedAuthProvider 

拡張: FederatedAuthProvider

コンストラクター

コンストラクタ修飾子説明
(コンストラクター)(プロバイダー ID)コンストラクタ。 ProviderId は「saml」で始まる必要があります。

メソッド

方法修飾子説明
credentialFromError(エラー) staticサインイン、リンク、または再認証操作中にスローされたAuthErrorから基になるOAuthCredentialを抽出するために使用されます。
credentialFromJSON(json) static JSON 文字列またはプレーン オブジェクトからAuthCredentialを作成します。
credentialFromResult(userCredential) static SAML フローが正常に完了した後、 UserCredentialからAuthCredentialを生成します。

SAMLAuthProvider.(コンストラクター)

コンストラクタ。 ProviderId は「saml」で始まる必要があります。

サイン:

constructor(providerId: string);

パラメーター

パラメータタイプ説明
プロバイダーIDSAMLプロバイダーID。

SAMLAuthProvider.credentialFromError()

サインイン、リンク、または再認証操作中にスローされたAuthErrorから基になるOAuthCredentialを抽出するために使用されます。

サイン:

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

パラメーター

パラメータタイプ説明
エラーFirebaseError

戻り値:

認証資格情報|ヌル

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;

パラメーター

パラメータタイプ説明
ユーザー資格情報ユーザー資格情報ユーザーの資格情報。

戻り値:

認証資格情報|ヌル