Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

SAMLAuthProvider class

An AuthProvider for SAML.

<b>Signature:</b>

export declare class SAMLAuthProvider extends FederatedAuthProvider 

<b>Extends:</b> FederatedAuthProvider

Constructors

Methods

SAMLAuthProvider.(constructor)

Constructor. The providerId must start with "saml."

<b>Signature:</b>

constructor(providerId: string);

Parameters

SAMLAuthProvider.credentialFromError()

Used to extract the underlying OAuthCredential from a AuthError which was thrown during a sign-in, link, or reauthenticate operation.

<b>Signature:</b>

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

Parameters

<b>Returns:</b>

AuthCredential | null

SAMLAuthProvider.credentialFromJSON()

Creates an AuthCredential from a JSON string or a plain object.

<b>Signature:</b>

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

Parameters

<b>Returns:</b>

AuthCredential

SAMLAuthProvider.credentialFromResult()

Generates an AuthCredential from a UserCredential after a successful SAML flow completes.

For example, to get an AuthCredential<!-- -->, you could write the following code:

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

<b>Signature:</b>

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

Parameters

<b>Returns:</b>

AuthCredential | null