SAMLAuthProvider class

Un AuthProvider para SAML

Firma:

export declare class SAMLAuthProvider extends FederatedAuthProvider 

Extiende: FederatedAuthProvider

Constructores

Constructor	Teclas modificadoras	Descripción
(constructor)(IDdelproveedor)		Constructor. El providerId debe comenzar con “saml”.

Métodos

Método	Teclas modificadoras	Descripción
credentialFromError(error)	static	Se usa para extraer la OAuthCredential subyacente de un AuthError que se haya producido durante una operación de acceso, vínculo o nueva autenticación.
credentialFromJSON(json)	static	Crea una AuthCredential a partir de una string JSON o un objeto sin formato.
credentialFromResult(userCredential)	static	Genera una AuthCredential a partir de una UserCredential después de que se complete un flujo de SAML correcto.

SAMLAuthProvider.(constructor)

Constructor. El providerId debe comenzar con “saml”.

Firma:

constructor(providerId: string);

Parámetros

Parámetro	Tipo	Descripción
providerId	string	Es el ID del proveedor de SAML.

SAMLAuthProvider.credentialFromError()

Se usa para extraer la OAuthCredential subyacente de un AuthError que se haya producido durante una operación de acceso, vínculo o nueva autenticación.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
error	FirebaseError.

Muestra:

AuthCredential | nulo

SAMLAuthProvider.credentialFromJSON()

Crea una AuthCredential a partir de una string JSON o un objeto sin formato.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
json	cadena | objeto	Un objeto sin formato o una cadena JSON

Muestra:

AuthCredential

SAMLAuthProvider.credentialFromResult()

Genera una AuthCredential a partir de una UserCredential después de que se complete un flujo de SAML correcto.

Por ejemplo, para obtener una AuthCredential, puedes escribir el siguiente código:

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

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
Credencial de usuario	Credencial de usuario	Es la credencial de usuario.

Muestra:

AuthCredential | nulo