You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This change updates links in code documentation that are in Markdown
format to be in the expected JSDoc link format, so that they can be
correctly parsed by the api-documenter.
Copy file name to clipboardExpand all lines: docs-devsite/auth.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,15 +28,15 @@ Firebase Authentication
28
28
|[confirmPasswordReset(auth, oobCode, newPassword)](./auth.md#confirmpasswordreset_749dad8)| Completes the password reset process, given a confirmation code and new password. |
29
29
|[connectAuthEmulator(auth, url, options)](./auth.md#connectauthemulator_657c7e5)| Changes the [Auth](./auth.auth.md#auth_interface) instance to communicate with the Firebase Auth Emulator, instead of production Firebase Auth services. |
30
30
|[createUserWithEmailAndPassword(auth, email, password)](./auth.md#createuserwithemailandpassword_21ad33b)| Creates a new user account associated with the specified email address and password. |
31
-
|[fetchSignInMethodsForEmail(auth, email)](./auth.md#fetchsigninmethodsforemail_efb3887)| Gets the list of possible sign in methods for the given email address. This method returns an empty list when \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, irrespective of the number of authentication methods available for the given email. |
31
+
|[fetchSignInMethodsForEmail(auth, email)](./auth.md#fetchsigninmethodsforemail_efb3887)| Gets the list of possible sign in methods for the given email address. This method returns an empty list when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, irrespective of the number of authentication methods available for the given email. |
32
32
|[getMultiFactorResolver(auth, error)](./auth.md#getmultifactorresolver_201ba61)| Provides a [MultiFactorResolver](./auth.multifactorresolver.md#multifactorresolver_interface) suitable for completion of a multi-factor flow. |
33
33
|[getRedirectResult(auth, resolver)](./auth.md#getredirectresult_c35dc1f)| Returns a [UserCredential](./auth.usercredential.md#usercredential_interface) from the redirect-based sign-in flow. |
34
34
|[initializeRecaptchaConfig(auth)](./auth.md#initializerecaptchaconfig_2a61ea7)| Loads the reCAPTCHA configuration into the <code>Auth</code> instance. |
35
35
|[isSignInWithEmailLink(auth, emailLink)](./auth.md#issigninwithemaillink_db04f1d)| Checks if an incoming link is a sign-in with email link suitable for [signInWithEmailLink()](./auth.md#signinwithemaillink_ed14c53)<!---->. |
36
36
|[onAuthStateChanged(auth, nextOrObserver, error, completed)](./auth.md#onauthstatechanged_b0d07ab)| Adds an observer for changes to the user's sign-in state. |
37
37
|[onIdTokenChanged(auth, nextOrObserver, error, completed)](./auth.md#onidtokenchanged_b0d07ab)| Adds an observer for changes to the signed-in user's ID token. |
38
38
|[revokeAccessToken(auth, token)](./auth.md#revokeaccesstoken_5556ad5)| Revokes the given access token. Currently only supports Apple OAuth access tokens. |
39
-
|[sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.md#sendpasswordresetemail_95b079b)| Sends a password reset email to the given email address. This method does not throw an error when there's no user account with the given email address and \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled. |
39
+
|[sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.md#sendpasswordresetemail_95b079b)| Sends a password reset email to the given email address. This method does not throw an error when there's no user account with the given email address and [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled. |
40
40
|[sendSignInLinkToEmail(auth, email, actionCodeSettings)](./auth.md#sendsigninlinktoemail_95b079b)| Sends a sign-in email link to the user with the specified email. |
41
41
|[setPersistence(auth, persistence)](./auth.md#setpersistence_a3592ac)| Changes the type of persistence on the [Auth](./auth.auth.md#auth_interface) instance for the currently saved <code>Auth</code> session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. |
42
42
|[signInAnonymously(auth)](./auth.md#signinanonymously_2a61ea7)| Asynchronously signs in as an anonymous user. |
@@ -136,7 +136,7 @@ Firebase Authentication
136
136
|[PhoneSingleFactorInfoOptions](./auth.phonesinglefactorinfooptions.md#phonesinglefactorinfooptions_interface)| Options used for single-factor sign-in. |
137
137
|[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| A resolver used for handling DOM specific operations like [signInWithPopup()](./auth.md#signinwithpopup_770f816) or [signInWithRedirect()](./auth.md#signinwithredirect_770f816)<!---->. |
138
138
|[ReactNativeAsyncStorage](./auth.reactnativeasyncstorage.md#reactnativeasyncstorage_interface)| Interface for a supplied <code>AsyncStorage</code>. |
139
-
|[RecaptchaParameters](./auth.recaptchaparameters.md#recaptchaparameters_interface)| Interface representing reCAPTCHA parameters.<!---->See the \[reCAPTCHA docs\](https://developers.google.com/recaptcha/docs/display\#render\_param) for the list of accepted parameters. All parameters are accepted except for <code>sitekey</code>: Firebase Auth provisions a reCAPTCHA for each project and will configure the site key upon rendering.<!---->For an invisible reCAPTCHA, set the <code>size</code> key to <code>invisible</code>. |
139
+
|[RecaptchaParameters](./auth.recaptchaparameters.md#recaptchaparameters_interface)| Interface representing reCAPTCHA parameters.<!---->See the [reCAPTCHA docs](https://developers.google.com/recaptcha/docs/display#render_param) for the list of accepted parameters. All parameters are accepted except for <code>sitekey</code>: Firebase Auth provisions a reCAPTCHA for each project and will configure the site key upon rendering.<!---->For an invisible reCAPTCHA, set the <code>size</code> key to <code>invisible</code>. |
140
140
|[TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface)| The class for asserting ownership of a TOTP second factor. Provided by [TotpMultiFactorGenerator.assertionForEnrollment()](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorassertionforenrollment) and [TotpMultiFactorGenerator.assertionForSignIn()](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorassertionforsignin)<!---->. |
141
141
|[TotpMultiFactorInfo](./auth.totpmultifactorinfo.md#totpmultifactorinfo_interface)| The subclass of the [MultiFactorInfo](./auth.multifactorinfo.md#multifactorinfo_interface) interface for TOTP second factors. The <code>factorId</code> of this second factor is [FactorId](./auth.md#factorid)<!---->.TOTP. |
142
142
|[User](./auth.user.md#user_interface)| A user account. |
Gets the list of possible sign in methods for the given email address. This method returns an empty list when \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, irrespective of the number of authentication methods available for the given email.
408
+
Gets the list of possible sign in methods for the given email address. This method returns an empty list when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, irrespective of the number of authentication methods available for the given email.
409
409
410
410
This is useful to differentiate methods of sign-in for the same provider, eg. [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) which has 2 methods of sign-in, [SignInMethod](./auth.md#signinmethod)<!---->.EMAIL\_PASSWORD and [SignInMethod](./auth.md#signinmethod)<!---->.EMAIL\_LINK.
411
411
@@ -420,7 +420,7 @@ export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): P
420
420
| Parameter | Type | Description |
421
421
| --- | --- | --- |
422
422
| auth |[Auth](./auth.auth.md#auth_interface)| The [Auth](./auth.auth.md#auth_interface) instance. |
423
-
| email | string | The user's email address.<!---->Deprecated. Migrating off of this method is recommended as a security best-practice. Learn more in the Identity Platform documentation for \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).|
423
+
| email | string | The user's email address.<!---->Deprecated. Migrating off of this method is recommended as a security best-practice. Learn more in the Identity Platform documentation for [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)<!---->. |
Sends a password reset email to the given email address. This method does not throw an error when there's no user account with the given email address and \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled.
633
+
Sends a password reset email to the given email address. This method does not throw an error when there's no user account with the given email address and [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled.
634
634
635
635
To complete the password reset, call [confirmPasswordReset()](./auth.md#confirmpasswordreset_749dad8) with the code supplied in the email sent to the user, along with the new password specified by the user.
Asynchronously signs in using an email and password.
841
841
842
-
Fails with an error if the email address and password do not match. When \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, this method fails with "auth/invalid-credential" in case of an invalid email/password.
842
+
Fails with an error if the email address and password do not match. When [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, this method fails with "auth/invalid-credential" in case of an invalid email/password.
843
843
844
844
This method is not supported on [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
| user |[User](./auth.user.md#user_interface)| The user. |
1666
-
| newEmail | string | The new email address.<!---->Throws "auth/operation-not-allowed" error when \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled. Deprecated - Use [verifyBeforeUpdateEmail()](./auth.md#verifybeforeupdateemail_09d6f11) instead. |
1666
+
| newEmail | string | The new email address.<!---->Throws "auth/operation-not-allowed" error when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled. Deprecated - Use [verifyBeforeUpdateEmail()](./auth.md#verifybeforeupdateemail_09d6f11) instead. |
See the \[reCAPTCHA docs\](https://developers.google.com/recaptcha/docs/display\#render\_param) for the list of accepted parameters. All parameters are accepted except for `sitekey`<!---->: Firebase Auth provisions a reCAPTCHA for each project and will configure the site key upon rendering.
15
+
See the [reCAPTCHA docs](https://developers.google.com/recaptcha/docs/display#render_param) for the list of accepted parameters. All parameters are accepted except for `sitekey`<!---->: Firebase Auth provisions a reCAPTCHA for each project and will configure the site key upon rendering.
16
16
17
17
For an invisible reCAPTCHA, set the `size` key to `invisible`<!---->.
Copy file name to clipboardExpand all lines: packages/auth/src/core/strategies/email.ts
+5-3Lines changed: 5 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -34,8 +34,9 @@ import { getModularInstance } from '@firebase/util';
34
34
35
35
/**
36
36
* Gets the list of possible sign in methods for the given email address. This method returns an
37
-
* empty list when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, irrespective of the number of
38
-
* authentication methods available for the given email.
* is enabled, irrespective of the number of authentication methods available for the given email.
39
40
*
40
41
* @remarks
41
42
* This is useful to differentiate methods of sign-in for the same provider, eg.
@@ -47,7 +48,8 @@ import { getModularInstance } from '@firebase/util';
47
48
* @param email - The user's email address.
48
49
*
49
50
* Deprecated. Migrating off of this method is recommended as a security best-practice.
50
-
* Learn more in the Identity Platform documentation for [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).
51
+
* Learn more in the Identity Platform documentation for
Copy file name to clipboardExpand all lines: packages/auth/src/core/user/account_info.ts
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -93,7 +93,9 @@ export async function updateProfile(
93
93
* @param user - The user.
94
94
* @param newEmail - The new email address.
95
95
*
96
-
* Throws "auth/operation-not-allowed" error when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled.
0 commit comments