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
Firebase App Check does not work in Node.js using `ReCaptchaV3Provider` or `ReCaptchaEnterpriseProvider`<!---->, but can be used in Node.js if you use `CustomProvider` and write your own attestation method.
Copy file name to clipboardExpand all lines: docs-devsite/auth.md
+19-8Lines changed: 19 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ Firebase Authentication
57
57
|[getIdToken(user, forceRefresh)](./auth.md#getidtoken)| Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. |
58
58
|[getIdTokenResult(user, forceRefresh)](./auth.md#getidtokenresult)| Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service. |
59
59
|[linkWithCredential(user, credential)](./auth.md#linkwithcredential)| Links the user account with the given credentials. |
60
-
|[linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.md#linkwithphonenumber)| Links the user account with the given phone number. |
60
+
|[linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.md#linkwithphonenumber)| Links the user account with the given phone number.<!---->This method is not available in Node.js.|
61
61
|[linkWithPopup(user, provider, resolver)](./auth.md#linkwithpopup)| Links the authenticated provider to the user account using a pop-up based OAuth flow. |
62
62
|[linkWithRedirect(user, provider, resolver)](./auth.md#linkwithredirect)| Links the [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class) to the user account using a full-page redirect flow. |
63
63
|[multiFactor(user)](./auth.md#multifactor)| The [MultiFactorUser](./auth.multifactoruser.md#multifactoruser_interface) corresponding to the user. |
@@ -92,7 +92,7 @@ Firebase Authentication
92
92
|[PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class)| Represents the credentials returned by [PhoneAuthProvider](./auth.phoneauthprovider.md#phoneauthprovider_class)<!---->. |
93
93
|[PhoneAuthProvider](./auth.phoneauthprovider.md#phoneauthprovider_class)| Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class)<!---->. |
94
94
|[PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md#phonemultifactorgenerator_class)| Provider for generating a [PhoneMultiFactorAssertion](./auth.phonemultifactorassertion.md#phonemultifactorassertion_interface)<!---->. |
95
-
|[RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class)| An [reCAPTCHA](https://www.google.com/recaptcha/)<!---->-based application verifier. |
95
+
|[RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class)| An [reCAPTCHA](https://www.google.com/recaptcha/)<!---->-based application verifier.<code>RecaptchaVerifier</code> is not available in Node.js.|
96
96
|[SAMLAuthProvider](./auth.samlauthprovider.md#samlauthprovider_class)| An [AuthProvider](./auth.authprovider.md#authprovider_interface) for SAML. |
97
97
|[TotpMultiFactorGenerator](./auth.totpmultifactorgenerator.md#totpmultifactorgenerator_class)| Provider for generating a [TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface)<!---->. |
98
98
|[TotpSecret](./auth.totpsecret.md#totpsecret_class)| Provider for generating a [TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface)<!---->.<!---->Stores the shared secret key and other parameters to generate time-based OTPs. Implements methods to retrieve the shared secret key and generate a QR code URL. |
@@ -147,7 +147,7 @@ Firebase Authentication
147
147
|[ActionCodeOperation](./auth.md#actioncodeoperation)| An enumeration of the possible email action types. |
148
148
|[AuthErrorCodes](./auth.md#autherrorcodes)| A map of potential <code>Auth</code> error codes, for easier comparison with errors thrown by the SDK. |
149
149
|[browserLocalPersistence](./auth.md#browserlocalpersistence)| An implementation of [Persistence](./auth.persistence.md#persistence_interface) of type <code>LOCAL</code> using <code>localStorage</code> for the underlying storage. |
150
-
|[browserPopupRedirectResolver](./auth.md#browserpopupredirectresolver)| An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for browser based applications. |
150
+
|[browserPopupRedirectResolver](./auth.md#browserpopupredirectresolver)| An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for browser based applications.<!---->This method is not available in Node.js.|
151
151
|[browserSessionPersistence](./auth.md#browsersessionpersistence)| An implementation of [Persistence](./auth.persistence.md#persistence_interface) of <code>SESSION</code> using <code>sessionStorage</code> for the underlying storage. |
152
152
|[cordovaPopupRedirectResolver](./auth.md#cordovapopupredirectresolver)| An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for Cordova based applications. |
153
153
|[debugErrorMap](./auth.md#debugerrormap)| A verbose error map with detailed descriptions for most error codes.<!---->See discussion at [AuthErrorMap](./auth.autherrormap.md#autherrormap_interface)|
| auth |[Auth](./auth.auth.md#auth_interface)| The [Auth](./auth.auth.md#auth_interface) instance. |
456
-
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->. |
456
+
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->.<!---->This method is not available in Node.js.|
457
457
458
458
<b>Returns:</b>
459
459
@@ -720,6 +720,7 @@ A `Promise` that resolves once the persistence change has completed
| auth |[Auth](./auth.auth.md#auth_interface)| The [Auth](./auth.auth.md#auth_interface) instance. |
927
929
| provider |[AuthProvider](./auth.authprovider.md#authprovider_interface)| The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!---->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
928
-
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->. |
930
+
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->.<!---->This method is not available in Node.js.|
929
931
930
932
<b>Returns:</b>
931
933
@@ -965,7 +967,7 @@ export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, r
965
967
| --- | --- | --- |
966
968
| auth |[Auth](./auth.auth.md#auth_interface)| The [Auth](./auth.auth.md#auth_interface) instance. |
967
969
| provider |[AuthProvider](./auth.authprovider.md#authprovider_interface)| The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!---->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
968
-
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->. |
970
+
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->.<!---->This method is not available in Node.js.|
Links the user account with the given phone number.
1206
1208
1209
+
This method is not available in Node.js.
1210
+
1207
1211
<b>Signature:</b>
1208
1212
1209
1213
```typescript
@@ -1257,6 +1261,7 @@ const provider = new FacebookAuthProvider();
1257
1261
awaitlinkWithPopup(result.user, provider);
1258
1262
1259
1263
```
1264
+
This method is not available in Node.js.
1260
1265
1261
1266
## linkWithRedirect()
1262
1267
@@ -1276,7 +1281,7 @@ export declare function linkWithRedirect(user: User, provider: AuthProvider, res
1276
1281
| --- | --- | --- |
1277
1282
| user |[User](./auth.user.md#user_interface)| The user. |
1278
1283
| provider |[AuthProvider](./auth.authprovider.md#authprovider_interface)| The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!---->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
1279
-
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->. |
1284
+
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->.<!---->This method is not available in Node.js.|
1280
1285
1281
1286
<b>Returns:</b>
1282
1287
@@ -1349,6 +1354,8 @@ Re-authenticates a user using a fresh phone credential.
1349
1354
1350
1355
Use before operations such as [updatePassword()](./auth.md#updatepassword) that require tokens from recent sign-in attempts.
1351
1356
1357
+
This method is not available in Node.js.
1358
+
1352
1359
<b>Signature:</b>
1353
1360
1354
1361
```typescript
@@ -1402,6 +1409,7 @@ const result = await signInWithPopup(auth, provider);
| user |[User](./auth.user.md#user_interface)| The user. |
1423
1431
| provider |[AuthProvider](./auth.authprovider.md#authprovider_interface)| The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!---->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
1424
-
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->. |
1432
+
| resolver |[PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)| An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!---->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!---->.<!---->This method is not available in Node.js.|
0 commit comments