auth package

Firebase Authentication

Fonctions

Fonction Description
fonction(application, ...)
getAuth(app) Renvoie l'instance Auth associée à l'élément FirebaseApp fourni. S'il n'existe aucune instance, initialise une instance Auth avec des dépendances par défaut spécifiques à la plate-forme.
initializeAuth(app, deps) Il initialise une instance Auth avec un contrôle ultraprécis sur les dépendances.
function(stockage, ...)
getReactNativePersistence(storage) Renvoie un objet de persistance qui encapsule AsyncStorage importé à partir de react-native ou @react-native-community/async-storage, et peut être utilisé dans le champ de dépendance de persistance dans initializeAuth().
fonction(auth, ...)
applyActionCode(auth, oobCode) Applique un code de validation envoyé à l'utilisateur par e-mail ou par un autre mécanisme externe.
beforeAuthStateChanged(auth, callback, onAbort) Ajoute un rappel bloquant qui s'exécute avant qu'un changement d'état d'authentification ne définisse un nouvel utilisateur.
checkActionCode(auth, oobCode) Vérifie un code de validation envoyé à l'utilisateur par e-mail ou par un autre mécanisme externe.
confirmPasswordReset(auth, oobCode, newPassword) Finalise le processus de réinitialisation du mot de passe, à l'aide d'un code de confirmation et d'un nouveau mot de passe.
connectAuthEmulator(auth, url, options) Modifie l'instance Auth pour communiquer avec l'émulateur Firebase Auth plutôt qu'avec les services Firebase Auth en production.
createUserWithEmailAndPassword(auth, email, password) Crée un compte utilisateur associé à l'adresse e-mail et au mot de passe spécifiés.
fetchSignInMethodsForEmail(auth, email) Récupère la liste des méthodes de connexion possibles pour l'adresse e-mail donnée. Cette méthode renvoie une liste vide lorsque la [protection contre l'énumération d'adresses e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) est activée, quel que soit le nombre de méthodes d'authentification disponibles pour l'adresse e-mail donnée.
getMultiFactorResolver(auth, error) Fournit un MultiFactorResolver adapté à la réalisation d'un flux multifacteur.
getRedirectResult(auth, resolver) Renvoie un UserCredential à partir du flux de connexion basé sur la redirection.
initializeRecaptchaConfig(auth) Il charge la configuration reCAPTCHA dans l'instance Auth.
isSignInWithEmailLink(auth, emailLink) Vérifie si un lien entrant est un lien de connexion par e-mail adapté à signInWithEmailLink().
onAuthStateChanged(auth, nextOrObserver, error, completed) Ajoute un observateur des modifications apportées à l'état de connexion de l'utilisateur.
onIdTokenChanged(auth, nextOrObserver, error, completed) Ajoute un observateur des modifications apportées au jeton d'ID de l'utilisateur connecté.
revokeAccessToken(auth, token) Révoque le jeton d'accès donné. Actuellement, seuls les jetons d'accès OAuth d'Apple sont acceptés.
sendPasswordResetEmail(auth, email, actionCodeSettings) Envoie un e-mail de réinitialisation du mot de passe à l'adresse e-mail indiquée. Cette méthode ne génère pas d'erreur lorsqu'aucun compte utilisateur n'est associé à l'adresse e-mail donnée et que la [protection contre l'énumération d'adresses e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) est activée.
sendSignInLinkToEmail(auth, email, actionCodeSettings) Envoie un lien de connexion par e-mail à l'utilisateur à l'adresse e-mail spécifiée.
setPersistence(auth, persistence) Modifie le type de persistance sur l'instance Auth pour la session Auth actuellement enregistrée, et applique ce type de persistance pour les futures requêtes de connexion, y compris pour les requêtes de redirection.
signInAnonymously(auth) Se connecte de manière asynchrone en tant qu'utilisateur anonyme.
signInWithCredential(auth, credential) Se connecte de manière asynchrone avec les identifiants fournis.
signInWithCustomToken(auth, customToken) Se connecte de manière asynchrone à l'aide d'un jeton personnalisé.
signInWithEmailAndPassword(auth, email, password) Se connecte de manière asynchrone à l'aide d'une adresse e-mail et d'un mot de passe.
signInWithEmailLink(auth, email, emailLink) Se connecte de manière asynchrone à l'aide d'un lien envoyé par e-mail et via une adresse e-mail de connexion.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) Se connecte de manière asynchrone à l'aide d'un numéro de téléphone.
signInWithPopup(auth, provider, resolver) Authentifie un client Firebase à l'aide d'un flux d'authentification OAuth basé sur un pop-up.
signInWithRedirect(auth, provider, resolver) Authentifie un client Firebase à l'aide d'un flux de redirection pleine page.
signOut(auth) Déconnexion de l'utilisateur actuel.
updateCurrentUser(auth, user) Définit de manière asynchrone l'utilisateur fourni en tant que Auth.currentUser sur l'instance Auth.
useDeviceLanguage(auth) Définit la langue actuelle sur les préférences par défaut du navigateur ou de l'appareil.
validatePassword(auth, password) Valide le mot de passe par rapport à la stratégie de mot de passe configurée pour le projet ou le locataire.
verifyPasswordResetCode(auth, code) Vérifie un code de réinitialisation du mot de passe envoyé à l'utilisateur par e-mail ou par un autre mécanisme externe.
fonction(lien, ...)
parseActionCodeURL(link) Analyse la chaîne du lien d'action de l'e-mail et renvoie une valeur ActionCodeURL si le lien est valide. Sinon, renvoie la valeur "null".
function(utilisateur, ...)
deleteUser(user) Supprime l'utilisateur et le déconnecte.
getIdToken(user, forceRefresh) Renvoie un jeton Web JSON (JWT, JSON Web Token) utilisé pour identifier l'utilisateur auprès d'un service Firebase.
getIdTokenResult(user, forceRefresh) Renvoie un jeton Web JSON (JWT) désérialisé utilisé pour identifier l'utilisateur auprès d'un service Firebase.
linkWithCredential(user, credential) Associe le compte utilisateur aux identifiants fournis.
linkWithPhoneNumber(user, phoneNumber, appVerifier) Associe le compte utilisateur au numéro de téléphone indiqué.
linkWithPopup(user, provider, resolver) Elle associe le fournisseur authentifié au compte utilisateur à l'aide d'un flux OAuth pop-up.
linkWithRedirect(user, provider, resolver) Il associe OAuthProvider au compte utilisateur à l'aide d'un flux de redirection en pleine page.
multiFactor(user) Valeur MultiFactorUser correspondant à l'utilisateur.
reauthenticateWithCredential(user, credential) Réauthentifie un utilisateur à l'aide de nouveaux identifiants.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) Réauthentifie un utilisateur à l'aide de nouveaux identifiants de téléphone.
reauthenticateWithPopup(user, provider, resolver) Réauthentifie l'utilisateur actuel avec le OAuthProvider spécifié à l'aide d'un flux OAuth pop-up.
reauthenticateWithRedirect(user, provider, resolver) Réauthentifie l'utilisateur actuel avec le fournisseur OAuthProvider spécifié à l'aide d'un flux de redirection en pleine page.
reload(utilisateur) Les données du compte utilisateur sont actualisées si l'utilisateur est connecté.
sendEmailVerification(user, actionCodeSettings) Envoie un e-mail de validation à un utilisateur.
unlink(user, providerId) Dissocie un fournisseur d'un compte utilisateur.
updateEmail(user, newEmail) Met à jour l'adresse e-mail de l'utilisateur.
updatePassword(user, newPassword) Met à jour le mot de passe de l'utilisateur.
updatePhoneNumber(user, credential) Met à jour le numéro de téléphone de l'utilisateur.
updateProfile(user, { displayName, photoURL: photoUrl }) Met à jour les données de profil d'un utilisateur.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) Envoie un e-mail de validation à une nouvelle adresse e-mail.
function(userCredential, ...)
getAdditionalUserInfo(userCredential) Extrait les informations AdditionalUserInfo spécifiques au fournisseur pour l'identifiant donné.

Classes

Classe Description
ActionCodeURL Classe utilitaire permettant d'analyser les URL d'action sur les e-mails (réinitialisation du mot de passe, validation de l'adresse e-mail, connexion par lien de l'e-mail, etc.).
AuthCredential Interface qui représente les identifiants renvoyés par un AuthProvider.
EmailAuthCredential Interface qui représente les identifiants renvoyés par EmailAuthProvider pour ProviderId.PASSWORD
EmailAuthProvider Fournisseur pour générer les identifiants EmailAuthCredential.
FacebookAuthProvider Fournisseur permettant de générer un OAuthCredential pour ProviderId.FACEBOOK.
GithubAuthProvider Fournisseur permettant de générer un OAuthCredential pour ProviderId.GITHUB.
GoogleAuthProvider Fournisseur permettant de générer un OAuthCredential pour ProviderId.GOOGLE.
OAuthCredential Représente les identifiants OAuth renvoyés par un OAuthProvider.
OAuthProvider Fournisseur pour générer le champ OAuthCredential générique.
PhoneAuthCredential Représente les identifiants renvoyés par PhoneAuthProvider.
PhoneAuthProvider Fournisseur pour générer un PhoneAuthCredential.
PhoneMultiFactorGenerator Fournisseur pour générer un PhoneMultiFactorAssertion.
RecaptchaVerifier Un vérificateur d'application basé sur reCAPTCHA.
SAMLAuthProvider Un fournisseur d'authentification (AuthProvider) pour SAML.
TotpMultiFactorGenerator Fournisseur permettant de générer un objet TotpMultiFactorAssertion.
TotpSecret Fournisseur permettant de générer un objet TotpMultiFactorAssertion.Stocke la clé secrète partagée et d'autres paramètres pour générer des mots de passe à usage unique basés sur le temps. Met en œuvre des méthodes permettant de récupérer la clé secrète partagée et de générer une URL de code QR.
TwitterAuthProvider Fournisseur permettant de générer un OAuthCredential pour ProviderId.TWITTER.

Interfaces

Interface Description
ActionCodeInfo Réponse de checkActionCode().
ActionCodeSettings Interface qui définit l'URL d'état/continue requise avec des identifiants de bundle Android et iOS facultatifs.
AdditionalUserInfo Structure contenant des informations utilisateur supplémentaires provenant d'un fournisseur d'identité fédérée.
ApplicationVerifier Un vérificateur pour la validation du domaine et la prévention des abus.
Authentification Interface représentant le service d'authentification Firebase.
AuthError Interface pour une erreur Auth.
AuthErrorMap Mise en correspondance des codes d'erreur avec les messages d'erreur
AuthProvider Interface qui représente un fournisseur d'authentification, utilisée pour faciliter la création d'AuthCredential.
AuthSettings Interface représentant les paramètres d'une instance Auth.
Configuration Interface représentant la configuration Auth.
ConfirmationResult Résultat d'une connexion à un numéro de téléphone, d'un lien ou d'une nouvelle authentification lors d'un appel.
Dépendances Dépendances pouvant être utilisées pour initialiser une instance Auth.
EmulatorConfig Configuration de l'émulateur Firebase Authentication.
IdTokenResult Interface représentant le résultat du jeton d'ID obtenu à partir de User.getIdTokenResult().
MultiFactorAssertion Classe de base permettant de revendiquer la propriété d'un deuxième facteur.
MultiFactorError Erreur générée lorsque l'utilisateur doit fournir un deuxième facteur pour se connecter correctement.
MultiFactorInfo Structure contenant les informations d'une entité à deuxième facteur.
MultiFactorResolver Classe utilisée pour faciliter la récupération à partir de MultiFactorError lorsqu'un utilisateur doit fournir un deuxième facteur pour se connecter.
MultiFactorSession Interface définissant l'objet de session multifacteur utilisé pour enregistrer un deuxième facteur sur un utilisateur ou aider à connecter un utilisateur inscrit avec un second facteur.
MultiFactorUser Interface qui définit les propriétés et opérations multifacteur liées à un élément User.
OAuthCredentialOptions Définit les options d'initialisation d'un élément OAuthCredential.
ParsedToken Interface représentant un jeton d'ID analysé.
PasswordPolicy Structure spécifiant les exigences de la stratégie de mots de passe.
PasswordValidationStatus Une structure indiquant les exigences de la politique de mots de passe qui ont été respectées ou enfreintes et quelles sont les exigences.
Persistance Interface couvrant les différents types de mécanismes de persistance
PhoneMultiFactorAssertion Classe permettant de revendiquer la propriété d'un deuxième facteur de téléphone. Fourni par PhoneMultiFactorGenerator.assertion().
PhoneMultiFactorEnrollInfoOptions Options utilisées pour l'inscription d'un deuxième facteur.
PhoneMultiFactorInfo Sous-classe de l'interface MultiFactorInfo pour les deuxièmes facteurs de numéro de téléphone. La factorId de ce deuxième facteur est FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions Options utilisées pour se connecter avec un deuxième facteur.
PhoneSingleFactorInfoOptions Options utilisées pour la connexion à un seul facteur.
PopupRedirectResolver Résolveur utilisé pour gérer les opérations DOM spécifiques comme signInWithPopup() ou signInWithRedirect().
ReactNativeAsyncStorage Interface pour un AsyncStorage fourni.
RecaptchaParameters Interface représentant les paramètres reCAPTCHA.Consultez la [documentation reCAPTCHA](https://developers.google.com/recaptcha/docs/display#render_param) pour obtenir la liste des paramètres acceptés. Tous les paramètres sont acceptés, sauf sitekey: Firebase Auth provisionne un reCAPTCHA pour chaque projet et configure la clé du site lors de l'affichage.Pour un reCAPTCHA invisible, définissez la clé size sur invisible.
TotpMultiFactorAssertion Classe permettant de revendiquer la propriété d'un second facteur TOTP. Fourni par TotpMultiFactorGenerator.assertionForEnrollment() et TotpMultiFactorGenerator.assertionForSignIn().
TotpMultiFactorInfo Sous-classe de l'interface MultiFactorInfo pour les seconds facteurs TOTP. La factorId de ce deuxième facteur est FactorId.TOTP.
Utilisateur Un compte utilisateur.
UserCredential Une structure contenant un élément User, le OperationType et l'ID du fournisseur.
UserInfo Les informations du profil utilisateur, visibles uniquement par les applications du projet Firebase.
UserMetadata Interface représentant les métadonnées d'un utilisateur.

Variables

Variable Description
ActionCodeOperation Énumération des types d'actions de messagerie possibles.
AuthErrorCodes Carte des codes d'erreur Auth potentiels, pour faciliter la comparaison avec les erreurs générées par le SDK.
browserLocalPersistence Une implémentation de la persistance de type LOCAL utilisant localStorage pour le stockage sous-jacent.
browserPopupRedirectResolver Une implémentation de PopupRedirectResolver adaptée aux applications basées sur un navigateur.
browserSessionPersistence Implémentation de la persistance de SESSION utilisant sessionStorage pour le stockage sous-jacent.
cordovaPopupRedirectResolver Une implémentation de PopupRedirectResolver adaptée aux applications basées sur Cordova.
debugErrorMap Carte détaillée des erreurs avec des descriptions détaillées pour la plupart des codes d'erreur.Consultez la discussion sur AuthErrorMap.
FactorId Énumération des facteurs pouvant être utilisés pour l'authentification multifacteur.
indexedDBLocalPersistence Une implémentation de la persistance de type LOCAL utilisant indexedDB pour le stockage sous-jacent.
inMemoryPersistence Implémentation de la propriété Persistence de type "NONE".
OperationType Énumération des types d'opérations compatibles.
prodErrorMap Mapper les erreurs minimales avec tous les messages d'erreur détaillés supprimés.Consultez la discussion sur AuthErrorMap.
ProviderId Énumération des fournisseurs acceptés.
SignInMethod Énumération des méthodes de connexion compatibles.

Alias de type

Saisir un alias Description
CustomParameters Mappage des paramètres personnalisés OAuth.
NextOrObserver Définition du type pour un rappel d'événement.
PhoneInfoOptions Informations requises pour confirmer que vous êtes le propriétaire d'un numéro de téléphone.
UserProfile Profil utilisateur utilisé dans AdditionalUserInfo.

fonction(app, ...)

getAuth(app)

Renvoie l'instance Auth associée à l'élément FirebaseApp fourni. S'il n'existe aucune instance, initialise une instance Auth avec des dépendances par défaut spécifiques à la plate-forme.

Signature :

export declare function getAuth(app?: FirebaseApp): Auth;

Paramètres

Paramètres Type Description
appli FirebaseApp L'application Firebase

Renvoie :

Authentification

initializeAuth(app, deps)

Il initialise une instance Auth avec un contrôle ultraprécis sur les dépendances.

Cette fonction offre plus de contrôle sur l'instance Auth que getAuth(). getAuth utilise des valeurs par défaut spécifiques à la plate-forme pour fournir les dépendances. En général, getAuth est le moyen le plus simple d'initialiser Auth et fonctionne dans la plupart des cas d'utilisation. Utilisez initializeAuth si vous avez besoin de contrôler quelle couche de persistance est utilisée, ou pour réduire la taille du groupe si vous n'utilisez ni signInWithPopup, ni signInWithRedirect.

Par exemple, si votre application n'utilise que des comptes anonymes et que vous souhaitez que seuls les comptes soient enregistrés pour la session en cours, initialisez Auth avec:

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

Signature :

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

Paramètres

Paramètres Type Description
appli FirebaseApp
dépendances Dépendances

Renvoie :

Authentification

fonction(stockage, ...)

getReactNativePersistence(storage)

Renvoie un objet de persistance qui encapsule AsyncStorage importé à partir de react-native ou @react-native-community/async-storage, et peut être utilisé dans le champ de dépendance de persistance dans initializeAuth().

Signature :

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

Paramètres

Paramètres Type Description
stockage ReactNativeAsyncStorage

Renvoie :

Persistance

fonction(auth, ...)

applyActionCode(auth, oobCode)

Applique un code de validation envoyé à l'utilisateur par e-mail ou par un autre mécanisme externe.

Signature :

export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
oobCode chaîne Un code de validation a été envoyé à l'utilisateur.

Renvoie :

Promise<void>

beforeAuthStateChanged(auth, callback, onAbort)

Ajoute un rappel bloquant qui s'exécute avant qu'un changement d'état d'authentification ne définisse un nouvel utilisateur.

Signature :

export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
rappel (user: User | null) => void | Promise<void> rappel déclenché avant la définition d'une nouvelle valeur utilisateur. Si cette erreur est générée, l'utilisateur ne peut pas être défini.
onAbort () => vide rappel déclenché si un rappel beforeAuthStateChanged() ultérieur est généré, ce qui vous permet d'annuler tous les effets secondaires.

Renvoie :

Se désabonner

checkActionCode(auth, oobCode)

Vérifie un code de validation envoyé à l'utilisateur par e-mail ou par un autre mécanisme externe.

Signature :

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
oobCode chaîne Un code de validation a été envoyé à l'utilisateur.

Renvoie :

Promise<ActionCodeInfo>

des métadonnées sur le code.

confirmPasswordReset(auth, oobCode, newPassword)

Finalise le processus de réinitialisation du mot de passe, à l'aide d'un code de confirmation et d'un nouveau mot de passe.

Signature :

export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
oobCode chaîne Un code de confirmation envoyé à l'utilisateur.
newPassword chaîne Le nouveau mot de passe.

Renvoie :

Promise<void>

connectAuthEmulator(auth, url, options)

Modifie l'instance Auth pour communiquer avec l'émulateur Firebase Auth plutôt qu'avec les services Firebase Auth en production.

Cette méthode doit être appelée de manière synchrone juste après le premier appel à initializeAuth(). Ne l'utilisez pas avec des identifiants de production, car le trafic de l'émulateur n'est pas chiffré.

Signature :

export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
    disableWarnings: boolean;
}): void;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
url chaîne URL de la page d'exécution de l'émulateur (par exemple, "http://localhost:9099").
options { disableWarnings: boolean; } Facultatif. options.disableWarnings a la valeur par défaut false. Définissez-la sur true pour désactiver la bannière d'avertissement jointe au DOM.

Renvoie :

void

Exemple

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword(auth, email, password)

Crée un compte utilisateur associé à l'adresse e-mail et au mot de passe spécifiés.

Si le compte utilisateur a bien été créé, l'utilisateur est également connecté à votre application.

La création d'un compte utilisateur peut échouer si le compte existe déjà ou si le mot de passe n'est pas valide.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
email chaîne Adresse e-mail de l'utilisateur.
mot de passe chaîne Mot de passe choisi par l'utilisateur.

Renvoie :

Promise<UserCredential>

fetchSignInMethodsForEmail(auth, email)

Récupère la liste des méthodes de connexion possibles pour l'adresse e-mail donnée. Cette méthode renvoie une liste vide lorsque la [protection contre l'énumération d'adresses e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) est activée, quel que soit le nombre de méthodes d'authentification disponibles pour l'adresse e-mail donnée.

Cela s'avère utile pour différencier les méthodes de connexion d'un même fournisseur, par exemple EmailAuthProvider, qui propose deux méthodes de connexion : SignInMethod.EMAIL_PASSWORD et SignInMethod.EMAIL_LINK.

Signature :

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
email chaîne Adresse e-mail de l'utilisateur.Obsolète. Nous vous recommandons de ne plus utiliser cette méthode comme bonne pratique de sécurité. Consultez la documentation Identity Platform sur la [protection contre l'énumération d'adresses e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

Renvoie :

Promesse<string[]>

getMultiFactorResolver(auth, error)

Fournit un MultiFactorResolver adapté à la réalisation d'un flux multifacteur.

Signature :

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
error MultiFactorError Erreur MultiFactorError, générée lors d'une opération de connexion ou de réauthentification.

Renvoie :

MultiFactorResolver

getRedirectResult(auth, resolver)

Renvoie un UserCredential à partir du flux de connexion basé sur la redirection.

Si la connexion aboutit, l'utilisateur connecté est renvoyé. Si la connexion échoue, elle échoue avec une erreur. Si aucune opération de redirection n'a été appelée, la fonction renvoie null.

Cette méthode ne fonctionne pas dans un environnement Node.js ni avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
résolveur PopupRedirectResolver Instance de PopupRedirectResolver, facultative si elle est déjà fournie à initializeAuth() ou fournie par getAuth().

Renvoie :

Promise<UserCredential | null>

Exemple

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

initializeRecaptchaConfig(auth)

Il charge la configuration reCAPTCHA dans l'instance Auth.

Cela charge la configuration reCAPTCHA, qui indique si le flux de validation reCAPTCHA doit être déclenché pour chaque fournisseur d'authentification, dans la session d'authentification en cours.

Si la méthode initialiserRecaptchaConfig() n'est pas appelée, le flux d'authentification démarre toujours sans validation reCAPTCHA. Si le fournisseur est configuré pour exiger la validation par reCAPTCHA, le SDK charge de manière transparente la configuration reCAPTCHA et redémarre les flux d'authentification.

Ainsi, en appelant cette méthode facultative, vous réduisez la latence des futurs flux d'authentification. Le chargement anticipé de la configuration reCAPTCHA améliore également le signal collecté par reCAPTCHA.

Cette méthode ne fonctionne pas dans un environnement Node.js.

Signature :

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.

Renvoie :

Promise<void>

Exemple

initializeRecaptchaConfig(auth);

Vérifie si un lien entrant est un lien de connexion par e-mail adapté à signInWithEmailLink().

Signature :

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
emailLink chaîne Lien envoyé à l'adresse e-mail de l'utilisateur.

Renvoie :

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

Ajoute un observateur des modifications apportées à l'état de connexion de l'utilisateur.

Pour conserver l'ancien comportement, consultez onIdTokenChanged().

Signature :

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
nextOrObserver NextOrObserver<Utilisateur> rappel déclenché lors d'une modification.
error ErrorFn Obsolète. Ce rappel n'est jamais déclenché. Les erreurs lors de la connexion/déconnexion peuvent être détectées dans les promesses renvoyées par les fonctions de connexion/déconnexion.
terminées CompleteFn Obsolète. Ce rappel n'est jamais déclenché.

Renvoie :

Se désabonner

onIdTokenChanged(auth, nextOrObserver, error, completed)

Ajoute un observateur des modifications apportées au jeton d'ID de l'utilisateur connecté.

Cela inclut les événements de connexion, de déconnexion et d'actualisation de jetons. Cette action ne se déclenche pas automatiquement à l'expiration du jeton d'ID. Utilisez User.getIdToken() pour actualiser le jeton d'ID.

Signature :

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
nextOrObserver NextOrObserver<Utilisateur> rappel déclenché lors d'une modification.
error ErrorFn Obsolète. Ce rappel n'est jamais déclenché. Les erreurs lors de la connexion/déconnexion peuvent être détectées dans les promesses renvoyées par les fonctions de connexion/déconnexion.
terminées CompleteFn Obsolète. Ce rappel n'est jamais déclenché.

Renvoie :

Se désabonner

revokeAccessToken(auth, token)

Révoque le jeton d'accès donné. Actuellement, seuls les jetons d'accès OAuth d'Apple sont acceptés.

Signature :

export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
jeton chaîne Jeton d'accès OAuth Apple.

Renvoie :

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Envoie un e-mail de réinitialisation du mot de passe à l'adresse e-mail indiquée. Cette méthode ne génère pas d'erreur lorsqu'aucun compte utilisateur n'est associé à l'adresse e-mail donnée et que la [protection contre l'énumération d'adresses e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) est activée.

Pour réinitialiser le mot de passe, appelez confirmPasswordReset() avec le code fourni dans l'e-mail envoyé à l'utilisateur, ainsi que le nouveau mot de passe spécifié par l'utilisateur.

Signature :

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
email chaîne Adresse e-mail de l'utilisateur.
actionCodeSettings ActionCodeSettings Le paramètre ActionCodeSettings.

Renvoie :

Promise<void>

Exemple

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('user@example.com', code);

sendSignInLinkToEmail(auth, email, actionCodeSettings)

Envoie un lien de connexion par e-mail à l'utilisateur à l'adresse e-mail spécifiée.

L'opération de connexion doit toujours être effectuée dans l'application, contrairement aux autres actions liées aux e-mails hors bande (réinitialisation du mot de passe et validations de l'adresse e-mail). En effet, à la fin du flux, l'utilisateur doit être connecté et son état d'authentification est conservé dans l'application.

Pour terminer la connexion à l'aide du lien envoyé par e-mail, appelez signInWithEmailLink() avec l'adresse e-mail et le lien fournis dans l'e-mail envoyé à l'utilisateur.

Signature :

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification
email chaîne Adresse e-mail de l'utilisateur.
actionCodeSettings ActionCodeSettings Le paramètre ActionCodeSettings.

Renvoie :

Promise<void>

Exemple

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

setPersistence(auth, persistence)

Modifie le type de persistance sur l'instance Auth pour la session Auth actuellement enregistrée, et applique ce type de persistance pour les futures requêtes de connexion, y compris pour les requêtes de redirection.

Cela permet à un utilisateur de se connecter facilement pour indiquer si sa session doit être mémorisée ou non. Il est également plus facile de ne jamais conserver l'état Auth pour les applications partagées par d'autres utilisateurs ou contenant des données sensibles.

Cette méthode ne fonctionne pas dans un environnement Node.js ni avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
persistance Persistance Valeur Persistance à utiliser.

Renvoie :

Promise<void>

Une Promise qui se résout une fois la modification de persistance terminée

Exemple

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

Se connecte de manière asynchrone en tant qu'utilisateur anonyme.

Si un utilisateur anonyme est déjà connecté, cet utilisateur est renvoyé. Sinon, une nouvelle identité d'utilisateur anonyme est créée et renvoyée.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.

Renvoie :

Promise<UserCredential>

signInWithCredential(auth, credential)

Se connecte de manière asynchrone avec les identifiants fournis.

Un AuthProvider peut être utilisé pour générer les identifiants.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
identifiant AuthCredential Identifiants d'authentification.

Renvoie :

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

Se connecte de manière asynchrone à l'aide d'un jeton personnalisé.

Les jetons personnalisés permettent d'intégrer l'authentification Firebase aux systèmes existants. Ils doivent être générés par un backend d'authentification à l'aide de la méthode createCustomToken du SDK Admin.

L'échec renvoie une erreur si le jeton n'est pas valide, a expiré ou n'est pas accepté par le service d'authentification Firebase.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
customToken chaîne Jeton personnalisé avec lequel se connecter.

Renvoie :

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

Se connecte de manière asynchrone à l'aide d'une adresse e-mail et d'un mot de passe.

L'échec renvoie une erreur si l'adresse e-mail et le mot de passe ne correspondent pas. Lorsque la [protection contre l'énumération d'adresses e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) est activée, cette méthode échoue avec "auth/invalid-credential" en cas d'adresse e-mail/mot de passe non valide.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
email chaîne Adresse e-mail de l'utilisateur.
mot de passe chaîne Mot de passe de l'utilisateur.

Renvoie :

Promise<UserCredential>

Se connecte de manière asynchrone à l'aide d'un lien envoyé par e-mail et via une adresse e-mail de connexion.

Si aucun lien n'est transmis, il est déduit de l'URL actuelle.

Une erreur est renvoyée si l'adresse e-mail n'est pas valide ou si le mot de passe à usage unique saisi dans l'e-mail expire.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
email chaîne Adresse e-mail de l'utilisateur.
emailLink chaîne Lien envoyé à l'adresse e-mail de l'utilisateur.

Renvoie :

Promise<UserCredential>

Exemple

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

signInWithPhoneNumber(auth, phoneNumber, appVerifier)

Se connecte de manière asynchrone à l'aide d'un numéro de téléphone.

Cette méthode envoie un code par SMS au numéro de téléphone indiqué et renvoie un élément ConfirmationResult. Une fois que l'utilisateur a fourni le code envoyé sur son téléphone, appelez ConfirmationResult.confirm() avec le code permettant de connecter l'utilisateur.

Pour prévenir les abus, cette méthode nécessite également un ApplicationVerifier. Ce SDK inclut une implémentation basée sur reCAPTCHA, RecaptchaVerifier. Cette fonction peut fonctionner sur d'autres plates-formes qui ne sont pas compatibles avec RecaptchaVerifier (comme React Native), mais vous devez utiliser une implémentation ApplicationVerifier tierce.

Cette méthode ne fonctionne pas dans un environnement Node.js ni avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
phoneNumber chaîne Numéro de téléphone de l'utilisateur au format E.164 (par exemple, +16505550101).
appVerifier ApplicationVerifier L'outil ApplicationVerifier.

Renvoie :

Promise<ConfirmationResult>

Exemple

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);

signInWithPopup(auth, provider, resolver)

Authentifie un client Firebase à l'aide d'un flux d'authentification OAuth basé sur un pop-up.

Si la requête aboutit, elle renvoie l'utilisateur connecté ainsi que les identifiants du fournisseur. Si la connexion échoue, renvoie un objet d'erreur contenant des informations supplémentaires sur l'erreur.

Cette méthode ne fonctionne pas dans un environnement Node.js ni avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
fournisseur AuthProvider Fournisseur à authentifier. Le fournisseur doit être un OAuthProvider. Les fournisseurs non-OAuth tels que EmailAuthProvider génèrent une erreur.
résolveur PopupRedirectResolver Instance de PopupRedirectResolver, facultative si elle est déjà fournie à initializeAuth() ou fournie par getAuth().

Renvoie :

Promise<UserCredential>

Exemple

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

signInWithRedirect(auth, provider, resolver)

Authentifie un client Firebase à l'aide d'un flux de redirection pleine page.

Pour gérer les résultats et les erreurs de cette opération, consultez getRedirectResult(). Suivez les bonnes pratiques lorsque vous utilisez signInWithRedirect().

Cette méthode ne fonctionne pas dans un environnement Node.js ni avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
fournisseur AuthProvider Fournisseur à authentifier. Le fournisseur doit être un OAuthProvider. Les fournisseurs non-OAuth tels que EmailAuthProvider génèrent une erreur.
résolveur PopupRedirectResolver Instance de PopupRedirectResolver, facultative si elle est déjà fournie à initializeAuth() ou fournie par getAuth().

Renvoie :

Promettre<jamais>

Exemple

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

signOut(auth)

Déconnexion de l'utilisateur actuel.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function signOut(auth: Auth): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.

Renvoie :

Promise<void>

updateCurrentUser(auth, user)

Définit de manière asynchrone l'utilisateur fourni en tant que Auth.currentUser sur l'instance Auth.

Une nouvelle copie de l'instance de l'utilisateur fourni sera créée et définie sur currentUser.

Cela déclenchera les écouteurs onAuthStateChanged() et onIdTokenChanged() comme les autres méthodes de connexion.

L'opération échoue et une erreur s'affiche si l'utilisateur à mettre à jour appartient à un autre projet Firebase.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
utilisateur Utilisateur | null Nouvel utilisateur.

Renvoie :

Promise<void>

useDeviceLanguage(auth)

Définit la langue actuelle sur les préférences par défaut du navigateur ou de l'appareil.

Signature :

export declare function useDeviceLanguage(auth: Auth): void;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.

Renvoie :

void

validatePassword(auth, password)

Valide le mot de passe par rapport à la stratégie de mot de passe configurée pour le projet ou le locataire.

Si aucun ID de locataire n'est défini sur l'instance Auth, cette méthode utilise la règle de mot de passe configurée pour le projet. Sinon, cette méthode utilisera la règle configurée pour le locataire. Si aucune règle de mot de passe n'a été configurée, la règle par défaut configurée pour tous les projets sera utilisée.

Si un flux d'authentification échoue parce qu'un mot de passe envoyé ne répond pas aux exigences des règles relatives aux mots de passe et que cette méthode a déjà été appelée, celle-ci utilisera la stratégie la plus récente disponible lorsqu'elle sera de nouveau appelée.

Signature :

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
mot de passe chaîne Mot de passe à valider.

Renvoie :

Promise<PasswordValidationStatus>

Exemple

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

Vérifie un code de réinitialisation du mot de passe envoyé à l'utilisateur par e-mail ou par un autre mécanisme externe.

Signature :

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

Paramètres

Paramètres Type Description
auth, authentification, authentifier Authentification L'instance Auth.
code chaîne Un code de validation a été envoyé à l'utilisateur.

Renvoie :

Promesse<chaîne>

l'adresse e-mail de l'utilisateur si celle-ci est valide.

fonction(lien, ...)

parseActionCodeURL(link)

Analyse la chaîne du lien d'action de l'e-mail et renvoie une valeur ActionCodeURL si le lien est valide. Sinon, renvoie la valeur "null".

Signature :

export declare function parseActionCodeURL(link: string): ActionCodeURL | null;

Paramètres

Paramètres Type Description
lien chaîne

Renvoie :

ActionCodeURL | null

fonction(utilisateur, ...)

deleteUser(user)

Supprime l'utilisateur et le déconnecte.

Signature :

export declare function deleteUser(user: User): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.

Renvoie :

Promise<void>

getIdToken(user, forceRefresh)

Renvoie un jeton Web JSON (JWT, JSON Web Token) utilisé pour identifier l'utilisateur auprès d'un service Firebase.

Renvoie le jeton actuel s'il n'a pas expiré ou s'il n'arrive pas à expiration dans les cinq minutes suivantes. Sinon, le jeton sera actualisé et un nouveau sera renvoyé.

Signature :

export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
forceRefresh boolean Forcer l'actualisation quelle que soit l'expiration du jeton.

Renvoie :

Promesse<chaîne>

getIdTokenResult(user, forceRefresh)

Renvoie un jeton Web JSON (JWT) désérialisé utilisé pour identifier l'utilisateur auprès d'un service Firebase.

Renvoie le jeton actuel s'il n'a pas expiré ou s'il n'arrive pas à expiration dans les cinq minutes suivantes. Sinon, le jeton sera actualisé et un nouveau sera renvoyé.

Signature :

export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
forceRefresh boolean Forcer l'actualisation quelle que soit l'expiration du jeton.

Renvoie :

Promise<IdTokenResult>

linkWithCredential(user, credential)

Associe le compte utilisateur aux identifiants fournis.

Un AuthProvider peut être utilisé pour générer les identifiants.

Signature :

export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
identifiant AuthCredential Identifiants d'authentification.

Renvoie :

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

Associe le compte utilisateur au numéro de téléphone indiqué.

Cette méthode ne fonctionne pas dans un environnement Node.js.

Signature :

export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
phoneNumber chaîne Numéro de téléphone de l'utilisateur au format E.164 (par exemple, +16505550101).
appVerifier ApplicationVerifier L'outil ApplicationVerifier.

Renvoie :

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

Elle associe le fournisseur authentifié au compte utilisateur à l'aide d'un flux OAuth pop-up.

Si l'association aboutit, le résultat renvoyé contiendra l'utilisateur et les identifiants du fournisseur.

Cette méthode ne fonctionne pas dans un environnement Node.js.

Signature :

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
fournisseur AuthProvider Fournisseur à authentifier. Le fournisseur doit être un OAuthProvider. Les fournisseurs non-OAuth tels que EmailAuthProvider génèrent une erreur.
résolveur PopupRedirectResolver Instance de PopupRedirectResolver, facultative si elle est déjà fournie à initializeAuth() ou fournie par getAuth().

Renvoie :

Promise<UserCredential>

Exemple

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);

linkWithRedirect(user, provider, resolver)

Il associe OAuthProvider au compte utilisateur à l'aide d'un flux de redirection en pleine page.

Pour gérer les résultats et les erreurs de cette opération, consultez getRedirectResult(). Suivez les bonnes pratiques lorsque vous utilisez linkWithRedirect().

Cette méthode ne fonctionne pas dans un environnement Node.js ni avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
fournisseur AuthProvider Fournisseur à authentifier. Le fournisseur doit être un OAuthProvider. Les fournisseurs non-OAuth tels que EmailAuthProvider génèrent une erreur.
résolveur PopupRedirectResolver Instance de PopupRedirectResolver, facultative si elle est déjà fournie à initializeAuth() ou fournie par getAuth().

Renvoie :

Promettre<jamais>

Exemple

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

multiFactor(user)

Valeur MultiFactorUser correspondant à l'utilisateur.

Permet d'accéder à toutes les propriétés et opérations multifacteur liées à l'utilisateur.

Signature :

export declare function multiFactor(user: User): MultiFactorUser;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.

Renvoie :

MultiFactorUser

reauthenticateWithCredential(user, credential)

Réauthentifie un utilisateur à l'aide de nouveaux identifiants.

À utiliser avant les opérations telles que updatePassword() qui nécessitent des jetons provenant de tentatives de connexion récentes. Cette méthode peut être utilisée pour effectuer une récupération après une erreur CREDENTIAL_TOO_OLD_LOGIN_AGAIN ou TOKEN_EXPIRED.

Cette méthode n'est pas compatible avec les utilisateurs connectés par des instances Auth créées avec FirebaseServerApp.

Signature :

export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
identifiant AuthCredential Identifiants d'authentification.

Renvoie :

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

Réauthentifie un utilisateur à l'aide de nouveaux identifiants de téléphone.

À utiliser avant les opérations telles que updatePassword() qui nécessitent des jetons provenant de tentatives de connexion récentes.

Cette méthode ne fonctionne pas dans un environnement Node.js ni sur aucun utilisateur connecté par des instances Auth créées avec FirebaseServerApp.

Signature :

export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
phoneNumber chaîne Numéro de téléphone de l'utilisateur au format E.164 (par exemple, +16505550101).
appVerifier ApplicationVerifier L'outil ApplicationVerifier.

Renvoie :

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

Réauthentifie l'utilisateur actuel avec le OAuthProvider spécifié à l'aide d'un flux OAuth pop-up.

Si la réauthentification aboutit, le résultat renvoyé contient l'utilisateur et les identifiants du fournisseur.

Cette méthode ne fonctionne pas dans un environnement Node.js ni sur aucun utilisateur connecté par des instances Auth créées avec FirebaseServerApp.

Signature :

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
fournisseur AuthProvider Fournisseur à authentifier. Le fournisseur doit être un OAuthProvider. Les fournisseurs non-OAuth tels que EmailAuthProvider génèrent une erreur.
résolveur PopupRedirectResolver Instance de PopupRedirectResolver, facultative si elle est déjà fournie à initializeAuth() ou fournie par getAuth().

Renvoie :

Promise<UserCredential>

Exemple

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

reauthenticateWithRedirect(user, provider, resolver)

Réauthentifie l'utilisateur actuel avec le fournisseur OAuthProvider spécifié à l'aide d'un flux de redirection en pleine page.

Pour gérer les résultats et les erreurs de cette opération, consultez la page getRedirectResult(). Suivez les bonnes pratiques pour utiliser reauthenticateWithRedirect().

Cette méthode ne fonctionne pas dans un environnement Node.js ni avec les instances Auth créées avec FirebaseServerApp.

Signature :

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
fournisseur AuthProvider Fournisseur à authentifier. Le fournisseur doit être un OAuthProvider. Les fournisseurs non-OAuth tels que EmailAuthProvider génèrent une erreur.
résolveur PopupRedirectResolver Instance de PopupRedirectResolver, facultative si elle est déjà fournie à initializeAuth() ou fournie par getAuth().

Renvoie :

Promettre<jamais>

Exemple

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

charger(utilisateur)

Les données du compte utilisateur sont actualisées si l'utilisateur est connecté.

Signature :

export declare function reload(user: User): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.

Renvoie :

Promise<void>

sendEmailVerification(user, actionCodeSettings)

Envoie un e-mail de validation à un utilisateur.

Pour terminer le processus de validation, appelez applyActionCode().

Signature :

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
actionCodeSettings ActionCodeSettings | null Le paramètre ActionCodeSettings.

Renvoie :

Promise<void>

Exemple

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

Dissocie un fournisseur d'un compte utilisateur.

Signature :

export declare function unlink(user: User, providerId: string): Promise<User>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
providerId chaîne Fournisseur à dissocier.

Renvoie :

Promettre<Utilisateur>

updateEmail(user, newEmail)

Met à jour l'adresse e-mail de l'utilisateur.

Un e-mail sera envoyé à l'adresse e-mail d'origine (si elle a été définie). Il pourra ainsi annuler le changement d'adresse e-mail afin de protéger son compte du piratage.

Cette méthode n'est pas compatible avec les utilisateurs connectés par des instances Auth créées avec FirebaseServerApp.

Signature :

export declare function updateEmail(user: User, newEmail: string): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
newEmail chaîne La nouvelle adresse e-mail.Génère l'erreur "auth/operation-not-allowed" lorsque la [protection contre l'énumération d'adresses e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) est activée. Obsolète : utilisez plutôt verifyBeforeUpdateEmail().

Renvoie :

Promise<void>

updatePassword(user, newPassword)

Met à jour le mot de passe de l'utilisateur.

Signature :

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
newPassword chaîne Le nouveau mot de passe.

Renvoie :

Promise<void>

updatePhoneNumber(user, credential)

Met à jour le numéro de téléphone de l'utilisateur.

Cette méthode ne fonctionne pas dans un environnement Node.js ni sur aucun utilisateur connecté par des instances Auth créées avec FirebaseServerApp.

Signature :

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
identifiant PhoneAuthCredential Un justificatif d'identité authentifiant le nouveau numéro de téléphone.

Renvoie :

Promise<void>

Exemple

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(user, { displayName, photoURL: photoUrl })

Met à jour les données de profil d'un utilisateur.

Signature :

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
{ displayName, photoURL: photoUrl } { displayName?: string | null; photoURL?: string | null; }

Renvoie :

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

Envoie un e-mail de validation à une nouvelle adresse e-mail.

Une fois la validation effectuée, l'adresse e-mail de l'utilisateur sera remplacée par la nouvelle adresse e-mail.

Si vous utilisez un gestionnaire d'actions personnalisé pour les e-mails, vous pouvez terminer le processus de validation en appelant applyActionCode().

Signature :

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Paramètres

Paramètres Type Description
utilisateur Utilisateur Utilisateur.
newEmail chaîne Nouvelle adresse e-mail à vérifier avant la mise à jour.
actionCodeSettings ActionCodeSettings | null Le paramètre ActionCodeSettings.

Renvoie :

Promise<void>

Exemple

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

fonction(userCredential, ...)

getAdditionalUserInfo(userCredential)

Extrait les informations AdditionalUserInfo spécifiques au fournisseur pour l'identifiant donné.

Signature :

export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;

Paramètres

Paramètres Type Description
userCredential UserCredential Identifiants de l'utilisateur.

Renvoie :

AdditionalUserInfo | null

ActionCodeOperation

Énumération des types d'actions de messagerie possibles.

Signature :

ActionCodeOperation: {
    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
    readonly PASSWORD_RESET: "PASSWORD_RESET";
    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}

AuthErrorCodes

Carte des codes d'erreur Auth potentiels, pour faciliter la comparaison avec les erreurs générées par le SDK.

Notez que vous ne pouvez pas secouer des clés individuelles dans la carte. Par conséquent, l'utilisation de la carte risque d'augmenter considérablement la taille du groupe.

Signature :

AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
    readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
    readonly ARGUMENT_ERROR: "auth/argument-error";
    readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
    readonly APP_NOT_INSTALLED: "auth/app-not-installed";
    readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
    readonly CODE_EXPIRED: "auth/code-expired";
    readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
    readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
    readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
    readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
    readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
    readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
    readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
    readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
    readonly EMAIL_EXISTS: "auth/email-already-in-use";
    readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
    readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
    readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
    readonly INTERNAL_ERROR: "auth/internal-error";
    readonly INVALID_API_KEY: "auth/invalid-api-key";
    readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
    readonly INVALID_APP_ID: "auth/invalid-app-id";
    readonly INVALID_AUTH: "auth/invalid-user-token";
    readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
    readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
    readonly INVALID_CODE: "auth/invalid-verification-code";
    readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
    readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
    readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
    readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
    readonly INVALID_EMAIL: "auth/invalid-email";
    readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
    readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
    readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
    readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
    readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
    readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
    readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
    readonly INVALID_OOB_CODE: "auth/invalid-action-code";
    readonly INVALID_ORIGIN: "auth/unauthorized-domain";
    readonly INVALID_PASSWORD: "auth/wrong-password";
    readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
    readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
    readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
    readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
    readonly INVALID_SENDER: "auth/invalid-sender";
    readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
    readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
    readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
    readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
    readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
    readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
    readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
    readonly MISSING_CODE: "auth/missing-verification-code";
    readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
    readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
    readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
    readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
    readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
    readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
    readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
    readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
    readonly MODULE_DESTROYED: "auth/app-deleted";
    readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
    readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
    readonly NULL_USER: "auth/null-user";
    readonly NO_AUTH_EVENT: "auth/no-auth-event";
    readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
    readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
    readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
    readonly POPUP_BLOCKED: "auth/popup-blocked";
    readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
    readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
    readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
    readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
    readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
    readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
    readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
    readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
    readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
    readonly TIMEOUT: "auth/timeout";
    readonly TOKEN_EXPIRED: "auth/user-token-expired";
    readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
    readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
    readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
    readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
    readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
    readonly UNVERIFIED_EMAIL: "auth/unverified-email";
    readonly USER_CANCELLED: "auth/user-cancelled";
    readonly USER_DELETED: "auth/user-not-found";
    readonly USER_DISABLED: "auth/user-disabled";
    readonly USER_MISMATCH: "auth/user-mismatch";
    readonly USER_SIGNED_OUT: "auth/user-signed-out";
    readonly WEAK_PASSWORD: "auth/weak-password";
    readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
    readonly ALREADY_INITIALIZED: "auth/already-initialized";
    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}

browserLocalPersistence

Une implémentation de la persistance de type LOCAL utilisant localStorage pour le stockage sous-jacent.

Signature :

browserLocalPersistence: Persistence

browserPopupRedirectResolver

Une implémentation de PopupRedirectResolver adaptée aux applications basées sur un navigateur.

Cette méthode ne fonctionne pas dans un environnement Node.js.

Signature :

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

Implémentation de la persistance de SESSION utilisant sessionStorage pour le stockage sous-jacent.

Signature :

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

Une implémentation de PopupRedirectResolver adaptée aux applications basées sur Cordova.

Signature :

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

Carte d'erreurs détaillée avec des descriptions détaillées pour la plupart des codes d'erreur.

Consultez la discussion sur AuthErrorMap.

Signature :

debugErrorMap: AuthErrorMap

FactorId

Énumération des facteurs pouvant être utilisés pour l'authentification multifacteur.

Signature :

FactorId: {
    readonly PHONE: "phone";
    readonly TOTP: "totp";
}

indexedDBLocalPersistence

Une implémentation de la persistance de type LOCAL utilisant indexedDB pour le stockage sous-jacent.

Signature :

indexedDBLocalPersistence: Persistence

inMemoryPersistence

Implémentation de la propriété Persistence de type "NONE".

Signature :

inMemoryPersistence: Persistence

OperationType

Énumération des types d'opérations compatibles.

Signature :

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

prodErrorMap

Un mappage d'erreurs minimal avec tous les messages d'erreur détaillés supprimés.

Consultez la discussion sur AuthErrorMap.

Signature :

prodErrorMap: AuthErrorMap

ProviderId

Énumération des fournisseurs acceptés.

Signature :

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

SignInMethod

Énumération des méthodes de connexion compatibles.

Signature :

SignInMethod: {
    readonly EMAIL_LINK: "emailLink";
    readonly EMAIL_PASSWORD: "password";
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

CustomParameters

Mappage des paramètres personnalisés OAuth.

Signature :

export declare type CustomParameters = Record<string, string>;

NextOrObserver

Définition du type pour un rappel d'événement.

Signature :

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

PhoneInfoOptions

Informations requises pour confirmer que vous êtes le propriétaire d'un numéro de téléphone.

Les informations requises varient selon que vous utilisez la connexion à un seul facteur, l'authentification multifacteur ou la connexion multifacteur.

Signature :

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

Profil utilisateur utilisé dans AdditionalUserInfo.

Signature :

export declare type UserProfile = Record<string, unknown>;