SAMLAuthProvider class

Un AuthProvider pour SAML.

Signature:

export declare class SAMLAuthProvider extends FederatedAuthProvider

Extension : FederatedAuthProvider

Constructeurs

Constructeur Modificateurs Description
(constructeur)(providerId) Constructeur. Le ProviderId doit commencer par « saml ».

Méthodes

Méthode Modificateurs Description
informations d'identificationFromError(erreur) static Utilisé pour extraire le OAuthCredential sous-jacent d’une AuthError qui a été levée lors d’une opération de connexion, de liaison ou de réauthentification.
informations d'identificationFromJSON(json) static Crée un AuthCredential à partir d'une chaîne JSON ou d'un objet simple.
informations d'identificationFromResult (userCredential) static Génère un AuthCredential à partir d'un UserCredential une fois qu'un flux SAML réussi est terminé.

SAMLAuthProvider. (constructeur)

Constructeur. Le ProviderId doit commencer par « saml ».

Signature:

constructor(providerId: string);

Paramètres

Paramètre Taper Description
ID du fournisseur chaîne ID du fournisseur SAML.

SAMLAuthProvider.credentialFromError()

Utilisé pour extraire le OAuthCredential sous-jacent d’une AuthError qui a été levée lors d’une opération de connexion, de liaison ou de réauthentification.

Signature:

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

Paramètres

Paramètre Taper Description
erreur Erreur Firebase

Retour:

AuthCredential | nul

SAMLAuthProvider.credentialFromJSON()

Crée un AuthCredential à partir d'une chaîne JSON ou d'un objet simple.

Signature:

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

Paramètres

Paramètre Taper Description
json chaîne | objet Un objet simple ou une chaîne JSON

Retour:

AuthCredential

SAMLAuthProvider.credentialFromResult()

Génère un AuthCredential à partir d'un UserCredential une fois qu'un flux SAML réussi est terminé.

Par exemple, pour obtenir un AuthCredential , vous pourriez écrire le code suivant :

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

Signature:

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

Paramètres

Paramètre Taper Description
identifiantutilisateur Informations d'identification de l'utilisateur Les informations d'identification de l'utilisateur.

Retour:

AuthCredential | nul