SAML 用の AuthProvider。
署名:
export declare class SAMLAuthProvider extends FederatedAuthProvider
拡張: FederatedAuthProvider
コンストラクタ
| コンストラクタ | 修飾キー | 説明 |
|---|---|---|
| (structor)(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;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| エラー | FirebaseError |
戻り値:
AuthCredential |null
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;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| userCredential | UserCredential（ユーザーの認証情報） | ユーザー認証情報。 |
戻り値:
AuthCredential |null