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
Copy file name to clipboardExpand all lines: docs-devsite/auth.md
+30-10Lines changed: 30 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -381,6 +381,8 @@ On successful creation of the user account, this user will also be signed in to
381
381
382
382
User account creation can fail if the account already exists or the password is invalid.
383
383
384
+
This method is not supported on [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
385
+
384
386
Note: The email address acts as a unique identifier for the user and enables an email-based password reset. This function will create a new user account and set the initial user password.
385
387
386
388
<b>Signature:</b>
@@ -451,7 +453,7 @@ Returns a [UserCredential](./auth.usercredential.md#usercredential_interface) fr
451
453
452
454
If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an error. If no redirect operation was called, returns `null`<!---->.
453
455
454
-
This method does not work in a Node.js environment.
456
+
This method does not work in a Node.js environment or with [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
455
457
456
458
<b>Signature:</b>
457
459
@@ -728,7 +730,7 @@ Changes the type of persistence on the [Auth](./auth.auth.md#auth_interface) ins
728
730
729
731
This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the `Auth` state for applications that are shared by other users or have sensitive data.
730
732
731
-
This method does not work in a Node.js environment.
733
+
This method does not work in a Node.js environment or with [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
732
734
733
735
<b>Signature:</b>
734
736
@@ -763,6 +765,8 @@ Asynchronously signs in as an anonymous user.
763
765
764
766
If there is already an anonymous user signed in, that user will be returned; otherwise, a new anonymous user identity will be created and returned.
765
767
768
+
This method is not supported by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
769
+
766
770
<b>Signature:</b>
767
771
768
772
```typescript
@@ -785,6 +789,8 @@ Asynchronously signs in with the given credentials.
785
789
786
790
An [AuthProvider](./auth.authprovider.md#authprovider_interface) can be used to generate the credential.
787
791
792
+
This method is not supported by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
793
+
788
794
<b>Signature:</b>
789
795
790
796
```typescript
@@ -810,6 +816,8 @@ Custom tokens are used to integrate Firebase Auth with existing auth systems, an
810
816
811
817
Fails with an error if the token is invalid, expired, or not accepted by the Firebase Auth service.
812
818
819
+
This method is not supported by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
820
+
813
821
<b>Signature:</b>
814
822
815
823
```typescript
@@ -833,6 +841,8 @@ Asynchronously signs in using an email and password.
833
841
834
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.
835
843
844
+
This method is not supported on [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
845
+
836
846
Note: The user's password is NOT the password used to access the user's email account. The email address serves as a unique identifier for the user, and the password is used to access the user's account in your Firebase project. See also: [createUserWithEmailAndPassword()](./auth.md#createuserwithemailandpassword_21ad33b)<!---->.
837
847
838
848
<b>Signature:</b>
@@ -861,6 +871,8 @@ If no link is passed, the link is inferred from the current URL.
861
871
862
872
Fails with an error if the email address is invalid or OTP in email link expires.
863
873
874
+
This method is not supported by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
875
+
864
876
Note: Confirm the link is a sign-in email link before calling this method firebase.auth.Auth.isSignInWithEmailLink.
865
877
866
878
<b>Signature:</b>
@@ -913,7 +925,7 @@ This method sends a code via SMS to the given phone number, and returns a [Confi
913
925
914
926
For abuse prevention, this method also requires a [ApplicationVerifier](./auth.applicationverifier.md#applicationverifier_interface)<!---->. This SDK includes a reCAPTCHA-based implementation, [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class)<!---->. This function can work on other platforms that do not support the [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class) (like React Native), but you need to use a third-party [ApplicationVerifier](./auth.applicationverifier.md#applicationverifier_interface) implementation.
915
927
916
-
This method does not work in a Node.js environment.
928
+
This method does not work in a Node.js environment or with [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
917
929
918
930
<b>Signature:</b>
919
931
@@ -951,7 +963,7 @@ Authenticates a Firebase client using a popup-based OAuth authentication flow.
951
963
952
964
If succeeds, returns the signed in user along with the provider's credential. If sign in was unsuccessful, returns an error object containing additional information about the error.
953
965
954
-
This method does not work in a Node.js environment.
966
+
This method does not work in a Node.js environment or with [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
955
967
956
968
<b>Signature:</b>
957
969
@@ -993,7 +1005,7 @@ Authenticates a Firebase client using a full-page redirect flow.
993
1005
994
1006
To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult_c35dc1f)<!---->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [signInWithRedirect()](./auth.md#signinwithredirect_770f816)<!---->.
995
1007
996
-
This method does not work in a Node.js environment.
1008
+
This method does not work in a Node.js environment or with [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
This method is not supported by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1061
+
1048
1062
<b>Signature:</b>
1049
1063
1050
1064
```typescript
@@ -1071,6 +1085,8 @@ This will trigger [onAuthStateChanged()](./auth.md#onauthstatechanged_b0d07ab) a
1071
1085
1072
1086
The operation fails with an error if the user to be updated belongs to a different Firebase project.
1073
1087
1088
+
This method is not supported by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1089
+
1074
1090
<b>Signature:</b>
1075
1091
1076
1092
```typescript
@@ -1347,7 +1363,7 @@ Links the [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class) to the us
1347
1363
1348
1364
To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult_c35dc1f)<!---->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [linkWithRedirect()](./auth.md#linkwithredirect_41c0b31)<!---->.
1349
1365
1350
-
This method does not work in a Node.js environment.
1366
+
This method does not work in a Node.js environment or with [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1351
1367
1352
1368
<b>Signature:</b>
1353
1369
@@ -1411,6 +1427,8 @@ Re-authenticates a user using a fresh credential.
1411
1427
1412
1428
Use before operations such as [updatePassword()](./auth.md#updatepassword_6df673e) that require tokens from recent sign-in attempts. This method can be used to recover from a `CREDENTIAL_TOO_OLD_LOGIN_AGAIN` error or a `TOKEN_EXPIRED` error.
1413
1429
1430
+
This method is not supported on any [User](./auth.user.md#user_interface) signed in by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1431
+
1414
1432
<b>Signature:</b>
1415
1433
1416
1434
```typescript
@@ -1434,7 +1452,7 @@ Re-authenticates a user using a fresh phone credential.
1434
1452
1435
1453
Use before operations such as [updatePassword()](./auth.md#updatepassword_6df673e) that require tokens from recent sign-in attempts.
1436
1454
1437
-
This method does not work in a Node.js environment.
1455
+
This method does not work in a Node.js environment or on any [User](./auth.user.md#user_interface) signed in by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1438
1456
1439
1457
<b>Signature:</b>
1440
1458
@@ -1460,7 +1478,7 @@ Reauthenticates the current user with the specified [OAuthProvider](./auth.oauth
1460
1478
1461
1479
If the reauthentication is successful, the returned result will contain the user and the provider's credential.
1462
1480
1463
-
This method does not work in a Node.js environment.
1481
+
This method does not work in a Node.js environment or on any [User](./auth.user.md#user_interface) signed in by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1464
1482
1465
1483
<b>Signature:</b>
1466
1484
@@ -1498,7 +1516,7 @@ Reauthenticates the current user with the specified [OAuthProvider](./auth.oauth
1498
1516
1499
1517
To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult_c35dc1f)<!---->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [reauthenticateWithRedirect()](./auth.md#reauthenticatewithredirect_41c0b31)<!---->.
1500
1518
1501
-
This method does not work in a Node.js environment.
1519
+
This method does not work in a Node.js environment or with [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1502
1520
1503
1521
<b>Signature:</b>
1504
1522
@@ -1630,6 +1648,8 @@ Updates the user's email address.
1630
1648
1631
1649
An email will be sent to the original email address (if it was set) that allows to revoke the email address change, in order to protect them from account hijacking.
1632
1650
1651
+
This method is not supported on any [User](./auth.user.md#user_interface) signed in by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
1652
+
1633
1653
Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call [reauthenticateWithCredential()](./auth.md#reauthenticatewithcredential_60f8043)<!---->.
1634
1654
1635
1655
<b>Signature:</b>
@@ -1676,7 +1696,7 @@ Promise<void>
1676
1696
1677
1697
Updates the user's phone number.
1678
1698
1679
-
This method does not work in a Node.js environment.
1699
+
This method does not work in a Node.js environment or on any [User](./auth.user.md#user_interface) signed in by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!---->.
Copy file name to clipboardExpand all lines: docs-devsite/auth.user.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -121,6 +121,8 @@ Deletes and signs out the user.
121
121
122
122
Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like [reauthenticateWithCredential()](./auth.md#reauthenticatewithcredential_60f8043)<!-- -->.
123
123
124
+
This method is not supported on any [User](./auth.user.md#user_interface) signed in by [Auth](./auth.auth.md#auth_interface) instances created with a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)<!-- -->.
0 commit comments