Xác thực Firebase
Chức năng
Chức năng | Sự miêu tả |
---|---|
chức năng (ứng dụng, ...) | |
getAuth(ứng dụng) | Trả về phiên bản Auth được liên kết với FirebaseApp được cung cấp . Nếu không có phiên bản nào tồn tại, hãy khởi tạo một phiên bản Auth với các phần phụ thuộc mặc định dành riêng cho nền tảng. |
khởi tạoAuth(ứng dụng, deps) | Khởi tạo phiên bản Auth với quyền kiểm soát chi tiết đối với Phụ thuộc . |
chức năng (lưu trữ, ...) | |
getReactNativePersistence(lưu trữ) | Trả về một đối tượng lưu giữ lâu dài bao bọc AsyncStorage được nhập từ react-native hoặc @react-native-community/async-storage và có thể được sử dụng trong trường phụ thuộc lưu trữ lâu dài trong initizeAuth() . |
hàm (xác thực, ...) | |
applyActionCode(auth, oobCode) | Áp dụng mã xác minh được gửi cho người dùng qua email hoặc cơ chế ngoài phạm vi khác. |
beforeAuthStateChanged(auth, gọi lại, onAbort) | Thêm lệnh gọi lại chặn chạy trước khi thay đổi trạng thái xác thực sẽ đặt người dùng mới. |
checkActionCode(auth, oobCode) | Kiểm tra mã xác minh được gửi cho người dùng qua email hoặc cơ chế ngoài băng tần khác. |
confirmPasswordReset(auth, oobCode, newPassword) | Hoàn tất quá trình đặt lại mật khẩu, được cung cấp mã xác nhận và mật khẩu mới. |
connectAuthEmulator(auth, url, tùy chọn) | Thay đổi phiên bản Auth để giao tiếp với Trình mô phỏng xác thực Firebase, thay vì sản xuất các dịch vụ Xác thực Firebase. |
createUserWithEmailAndPassword(auth, email, mật khẩu) | Tạo một tài khoản người dùng mới được liên kết với địa chỉ email và mật khẩu được chỉ định. |
tìm nạpSignInMethodsForEmail(auth, email) | Lấy danh sách các phương thức đăng nhập có thể áp dụng cho địa chỉ email đã cho. Phương thức này trả về một danh sách trống khi [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật, bất kể số lượng phương thức xác thực có sẵn cho email đã cho. |
getMultiFactorResolver(xác thực, lỗi) | Cung cấp MultiFactorResolver phù hợp để hoàn thành quy trình đa yếu tố. |
getRedirectResult(xác thực, trình phân giải) | Trả về UserCredential từ luồng đăng nhập dựa trên chuyển hướng. |
khởi tạoRecaptchaConfig(auth) | Tải cấu hình reCAPTCHA vào phiên bản Auth . |
isSignInWithEmailLink(auth, emailLink) | Kiểm tra xem liên kết đến có phải là liên kết đăng nhập bằng liên kết email phù hợp cho signInWithEmailLink() không . |
onAuthStateChanged(auth, nextOrObserver, lỗi, đã hoàn thành) | Thêm người quan sát những thay đổi đối với trạng thái đăng nhập của người dùng. |
onIdTokenChanged(auth, nextOrObserver, lỗi, đã hoàn thành) | Thêm người quan sát những thay đổi đối với mã thông báo ID của người dùng đã đăng nhập. |
thu hồiAccessToken(auth, token) | Thu hồi mã thông báo truy cập đã cho. Hiện chỉ hỗ trợ mã thông báo truy cập OAuth của Apple. |
sendPasswordResetEmail(auth, email, actionCodeSettings) | Gửi email đặt lại mật khẩu đến địa chỉ email đã cho. Phương pháp này không gây ra lỗi khi không có tài khoản người dùng nào có địa chỉ email đã cho và [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật . |
sendSignInLinkToEmail(auth, email, actionCodeSettings) | Gửi liên kết email đăng nhập tới người dùng bằng email được chỉ định. |
setPersistence(auth, kiên trì) | Thay đổi loại lưu giữ trên phiên bản Auth cho phiên Auth hiện đã lưu và áp dụng loại lưu giữ này cho các yêu cầu đăng nhập trong tương lai, bao gồm cả đăng nhập bằng yêu cầu chuyển hướng. |
signInAnonymous(auth) | Đăng nhập không đồng bộ với tư cách là người dùng ẩn danh. |
signInWithCredential(auth, thông tin xác thực) | Đăng nhập không đồng bộ bằng thông tin đăng nhập đã cho. |
signInWithCustomToken(auth, customToken) | Đăng nhập không đồng bộ bằng cách sử dụng mã thông báo tùy chỉnh. |
signInWithEmailAndPassword(auth, email, mật khẩu) | Đăng nhập không đồng bộ bằng email và mật khẩu. |
signInWithEmailLink(auth, email, emailLink) | Đăng nhập không đồng bộ bằng email và liên kết email đăng nhập. |
signInWithPhoneNumber(auth, phoneNumber, appVerifier) | Đăng nhập không đồng bộ bằng cách sử dụng số điện thoại. |
signInWithPopup(auth, nhà cung cấp, trình phân giải) | Xác thực ứng dụng khách Firebase bằng luồng xác thực OAuth dựa trên cửa sổ bật lên. |
signInWithRedirect(auth, nhà cung cấp, trình phân giải) | Xác thực ứng dụng khách Firebase bằng luồng chuyển hướng toàn trang. |
signOut(auth) | Đăng xuất người dùng hiện tại. |
updateCurrentUser(auth, user) | Đặt không đồng bộ người dùng được cung cấp làm Auth.currentUser trên phiên bản Auth . |
useDeviceLanguage(auth) | Đặt ngôn ngữ hiện tại thành tùy chọn thiết bị/trình duyệt mặc định. |
xác thựcPassword(xác thực, mật khẩu) | Xác thực mật khẩu theo chính sách mật khẩu được định cấu hình cho dự án hoặc đối tượng thuê. |
verifyPasswordResetCode(auth, code) | Kiểm tra mã đặt lại mật khẩu được gửi cho người dùng qua email hoặc cơ chế ngoài băng tần khác. |
chức năng (liên kết, ...) | |
phân tích cú phápActionCodeURL(liên kết) | Phân tích chuỗi liên kết hành động email và trả về ActionCodeURL nếu liên kết hợp lệ, nếu không thì trả về giá trị rỗng. |
chức năng (người dùng, ...) | |
xóaNgười dùng(người dùng) | Xóa và đăng xuất người dùng. |
getIdToken(người dùng, ForceRefresh) | Trả về Mã thông báo web JSON (JWT) được sử dụng để nhận dạng người dùng cho dịch vụ Firebase. |
getIdTokenResult(người dùng, ForceRefresh) | Trả về Mã thông báo web JSON đã được khử tuần tự hóa (JWT) được sử dụng để nhận dạng người dùng cho dịch vụ Firebase. |
linkWithCredential(người dùng, thông tin xác thực) | Liên kết tài khoản người dùng với thông tin xác thực nhất định. |
linkWithPhoneNumber(người dùng, số điện thoại, appVerifier) | Liên kết tài khoản người dùng với số điện thoại nhất định. |
linkWithPopup(người dùng, nhà cung cấp, trình phân giải) | Liên kết nhà cung cấp được xác thực với tài khoản người dùng bằng luồng OAuth dựa trên cửa sổ bật lên. |
linkWithRedirect(người dùng, nhà cung cấp, trình phân giải) | Liên kết OAuthProvider với tài khoản người dùng bằng luồng chuyển hướng toàn trang. |
đa yếu tố (người dùng) | MultiFactorUser tương ứng với người dùng. |
xác thực lạiWithCredential(người dùng, thông tin xác thực) | Xác thực lại người dùng bằng thông tin xác thực mới. |
xác thực lạiWithPhoneNumber(người dùng, số điện thoại, appVerifier) | Xác thực lại người dùng bằng thông tin xác thực điện thoại mới. |
xác thực lạiWithPopup(người dùng, nhà cung cấp, trình phân giải) | Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng luồng OAuth dựa trên cửa sổ bật lên. |
xác thực lạiWithRedirect(người dùng, nhà cung cấp, trình phân giải) | Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng luồng chuyển hướng toàn trang. |
tải lại (người dùng) | Tải lại dữ liệu tài khoản người dùng, nếu đăng nhập. |
sendEmailVerification(người dùng, actionCodeSettings) | Gửi email xác minh cho người dùng. |
hủy liên kết(người dùng, nhà cung cấpId) | Hủy liên kết nhà cung cấp khỏi tài khoản người dùng. |
updateEmail(người dùng, email mới) | Cập nhật địa chỉ email của người dùng. |
updatePassword(người dùng, newPassword) | Cập nhật mật khẩu của người dùng. |
updatePhoneNumber(người dùng, thông tin xác thực) | Cập nhật số điện thoại của người dùng. |
updateProfile(người dùng, { displayName, photoURL: photoUrl }) | Cập nhật dữ liệu hồ sơ của người dùng. |
verifyBeforeUpdateEmail(người dùng, email mới, actionCodeSettings) | Gửi email xác minh đến địa chỉ email mới. |
chức năng (thông tin người dùng, ...) | |
getAdditionalUserInfo(userCredential) | Trích xuất Thông tin người dùng bổ sung cụ thể của nhà cung cấp cho thông tin xác thực nhất định. |
Các lớp học
Lớp học | Sự miêu tả |
---|---|
URL mã hành động | Một lớp tiện ích để phân tích các URL hành động email như đặt lại mật khẩu, xác minh email, đăng nhập liên kết email, v.v. |
Thông tin xác thực | Giao diện đại diện cho thông tin xác thực được AuthProvider trả về . |
EmailXác thựcThông tin xác thực | Giao diện đại diện cho thông tin xác thực được EmailAuthProvider trả về cho ProviderId .MẬT KHẨU |
Nhà cung cấp xác thực email | Nhà cung cấp để tạo EmailAuthCredential . |
Nhà cung cấp xác thực Facebook | Nhà cung cấp để tạo OAuthCredential cho ProviderId .FACEBOOK. |
Nhà cung cấp GithubAuth | Nhà cung cấp để tạo OAuthCredential cho ProviderId .GITHUB. |
Nhà cung cấp GoogleAuth | Nhà cung cấp để tạo OAuthCredential cho ProviderId .GOOGLE. |
Thông tin xác thực OAuth | Đại diện cho thông tin xác thực OAuth được OAuthProvider trả về . |
Nhà cung cấp OAuth | Nhà cung cấp để tạo OAuthCredential chung . |
Thông tin xác thực điện thoại | Đại diện cho thông tin xác thực được trả về bởi PhoneAuthProvider . |
Nhà cung cấp xác thực điện thoại | Nhà cung cấp để tạo PhoneAuthCredential . |
Máy phát điện thoại MultiFactor | Nhà cung cấp để tạo PhoneMultiFactorAssertion . |
Trình xác minh lại hình ảnh xác thực | CAPTCHA reCAPTCHA dựa trên trình xác minh ứng dụng. |
Nhà cung cấp SAMLAuth | Nhà cung cấp xác thực cho SAML. |
Máy phát điện TotpMultiFactor | Nhà cung cấp để tạo TotpMultiFactorAssertion . |
totpbí mật | Nhà cung cấp để tạo TotpMultiFactorAssertion . Lưu trữ khóa bí mật dùng chung và các tham số khác để tạo OTP dựa trên thời gian. Triển khai các phương pháp truy xuất khóa bí mật dùng chung và tạo URL mã QR. |
Nhà cung cấp TwitterAuth | Nhà cung cấp để tạo OAuthCredential cho ProviderId .TWITTER. |
Giao diện
Giao diện | Sự miêu tả |
---|---|
Thông tin mã hành động | Phản hồi từ checkActionCode() . |
Cài đặt mã hành động | Giao diện xác định URL tiếp tục/trạng thái bắt buộc với mã nhận dạng gói Android và iOS tùy chọn. |
Thông tin người dùng bổ sung | Cấu trúc chứa thông tin người dùng bổ sung từ nhà cung cấp danh tính liên kết. |
Trình xác minh ứng dụng | Trình xác minh để xác minh tên miền và ngăn chặn lạm dụng. |
Xác thực | Giao diện đại diện cho dịch vụ Firebase Auth. |
Lỗi xác thực | Giao diện cho lỗi Auth . |
Bản đồ lỗi xác thực | Ánh xạ mã lỗi tới các thông báo lỗi. |
Nhà cung cấp xác thực | Giao diện đại diện cho nhà cung cấp xác thực, được sử dụng để hỗ trợ tạo AuthCredential . |
Cài đặt xác thực | Giao diện đại diện cho cài đặt của phiên bản Auth . |
Cấu hình | Giao diện đại diện cho cấu hình Auth . |
Xác nhậnKết quả | Kết quả từ việc đăng nhập, liên kết hoặc xác thực lại số điện thoại. |
phụ thuộc | Các phần phụ thuộc có thể được sử dụng để khởi tạo phiên bản Auth . |
Cấu hình trình mô phỏng | Cấu hình Trình mô phỏng xác thực Firebase. |
IdTokenKết quả | Giao diện biểu thị kết quả mã thông báo ID thu được từ User.getIdTokenResult() . |
Khẳng định đa yếu tố | Lớp cơ sở để khẳng định quyền sở hữu yếu tố thứ hai. |
Lỗi đa yếu tố | Lỗi xảy ra khi người dùng cần cung cấp yếu tố thứ hai để đăng nhập thành công. |
Thông tin đa yếu tố | Một cấu trúc chứa thông tin của thực thể nhân tố thứ hai. |
MultiFactorResolver | Lớp được sử dụng để hỗ trợ khôi phục từ MultiFactorError khi người dùng cần cung cấp yếu tố thứ hai để đăng nhập. |
Phiên đa yếu tố | Giao diện xác định đối tượng phiên đa yếu tố được sử dụng để đăng ký yếu tố thứ hai cho người dùng hoặc giúp đăng nhập người dùng đã đăng ký bằng yếu tố thứ hai. |
Người dùng đa yếu tố | Giao diện xác định các thuộc tính và hoạt động liên quan đến nhiều yếu tố liên quan đến Người dùng . |
Tùy chọn thông tin xác thực OAuth | Xác định các tùy chọn để khởi tạo OAuthCredential . |
Mã thông báo được phân tích cú pháp | Giao diện đại diện cho mã thông báo ID được phân tích cú pháp. |
Chính sách mật khẩu | Một cấu trúc xác định các yêu cầu chính sách mật khẩu. |
Trạng thái xác thực mật khẩu | Cấu trúc chỉ ra những yêu cầu chính sách mật khẩu nào đã được đáp ứng hoặc vi phạm và những yêu cầu đó là gì. |
Kiên trì | Một giao diện bao gồm các loại cơ chế bền vững có thể có. |
Khẳng định PhoneMultiFactor | Lớp để khẳng định quyền sở hữu yếu tố thứ hai của điện thoại. Được cung cấp bởi PhoneMultiFactorGenerator.assertion() . |
PhoneMultiFactorEnrollInfoOptions | Các tùy chọn được sử dụng để đăng ký yếu tố thứ hai. |
Thông tin điện thoạiMultiFactor | Lớp con của giao diện MultiFactorInfo cho các yếu tố thứ hai của số điện thoại. factorId của yếu tố thứ hai này là FactorId .ĐIỆN THOẠI. |
PhoneMultiFactorSignInInfoOptions | Các tùy chọn được sử dụng để đăng nhập bằng yếu tố thứ hai. |
PhoneSingleFactorInfoOptions | Các tùy chọn được sử dụng để đăng nhập một yếu tố. |
PopupRedirectResolver | Trình phân giải được sử dụng để xử lý các hoạt động cụ thể của DOM như signInWithPopup() hoặc signInWithRedirect() . |
ReactNativeAsyncStorage | Giao diện cho AsyncStorage được cung cấp. |
RecaptchaThông số | Giao diện đại diện cho các thông số reCAPTCHA. Hãy xem [tài liệu reCAPTCHA](https://developers.google.com/recaptcha/docs/display#render_param) để biết danh sách các tham số được chấp nhận. Tất cả các tham số đều được chấp nhận ngoại trừ sitekey : Firebase Auth cung cấp reCAPTCHA cho từng dự án và sẽ định cấu hình khóa trang web khi hiển thị. Đối với reCAPTCHA ẩn, hãy đặt khóa size thành invisible . |
Khẳng định TotpMultiFactor | Lớp để khẳng định quyền sở hữu yếu tố thứ hai TOTP. Được cung cấp bởi TotpMultiFactorGenerator.assertionForEnrollment() và TotpMultiFactorGenerator.assertionForSignIn() . |
Thông tin TotpMultiFactor | Lớp con của giao diện MultiFactorInfo cho các yếu tố thứ hai TOTP. factorId của yếu tố thứ hai này là FactorId .TOTP. |
Người dùng | Một tài khoản người dùng. |
Thông tin người dùng | Cấu trúc chứa Người dùng , Kiểu hoạt động và ID nhà cung cấp. |
Thông tin người dùng | Thông tin hồ sơ người dùng, chỉ hiển thị với các ứng dụng của dự án Firebase. |
Siêu dữ liệu người dùng | Giao diện đại diện cho siêu dữ liệu của người dùng. |
Biến
Biến đổi | Sự miêu tả |
---|---|
Mã hành độngHoạt động | Một bảng liệt kê các loại hành động email có thể có. |
Mã lỗi xác thực | Bản đồ các mã lỗi Auth thực tiềm ẩn để dễ dàng so sánh hơn với các lỗi do SDK đưa ra. |
trình duyệtLocalPersistence | Việc triển khai Persistence thuộc loại LOCAL bằng cách sử dụng localStorage cho bộ lưu trữ cơ bản. |
trình duyệtPopupRedirectResolver | Việc triển khai PopupRedirectResolver phù hợp cho các ứng dụng dựa trên trình duyệt. |
trình duyệtSessionPersistence | Việc triển khai Tính bền vững của SESSION bằng cách sử dụng sessionStorage cho bộ lưu trữ cơ bản. |
cordovaPopupRedirectResolver | Việc triển khai PopupRedirectResolver phù hợp với các ứng dụng dựa trên Cordova. |
gỡ lỗiErrorMap | Bản đồ lỗi chi tiết với mô tả chi tiết cho hầu hết các mã lỗi. Xem thảo luận tại AuthErrorMap |
Id yếu tố | Một danh sách các yếu tố có thể được sử dụng để xác thực đa yếu tố. |
được lập chỉ mụcDBLocalPersistence | Việc triển khai Persistence thuộc loại LOCAL bằng cách sử dụng indexedDB cho bộ lưu trữ cơ bản. |
inMemoryPersistence | Việc triển khai Persistence thuộc loại 'NONE'. |
Loại hoạt động | Liệt kê các loại hoạt động được hỗ trợ. |
bản đồ lỗi sản phẩm | Bản đồ lỗi tối thiểu với tất cả các thông báo lỗi dài dòng bị loại bỏ. Xem thảo luận tại AuthErrorMap |
Id nhà cung cấp | Danh sách các nhà cung cấp được hỗ trợ. |
Phương thức đăng nhập | Liệt kê các phương thức đăng nhập được hỗ trợ. |
Nhập bí danh
Nhập bí danh | Sự miêu tả |
---|---|
Thông số tùy chỉnh | Bản đồ các thông số tùy chỉnh OAuth. |
Tiếp theoHoặcObserver | Định nghĩa loại cho một cuộc gọi lại sự kiện. |
Tùy chọn thông tin điện thoại | Thông tin cần thiết để xác minh quyền sở hữu số điện thoại. |
Thông tin người dùng | Hồ sơ người dùng được sử dụng trong AddedUserInfo . |
chức năng (ứng dụng, ...)
getAuth(ứng dụng)
Trả về phiên bản Auth được liên kết với FirebaseApp được cung cấp . Nếu không có phiên bản nào tồn tại, hãy khởi tạo một phiên bản Auth với các phần phụ thuộc mặc định dành riêng cho nền tảng.
Chữ ký:
export declare function getAuth(app?: FirebaseApp): Auth;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
ứng dụng | Ứng dụng Firebase | Ứng dụng Firebase. |
Trả về:
khởi tạoAuth(ứng dụng, deps)
Khởi tạo phiên bản Auth với quyền kiểm soát chi tiết đối với Phụ thuộc .
Hàm này cho phép kiểm soát phiên bản Auth nhiều hơn getAuth() . getAuth
sử dụng các giá trị mặc định dành riêng cho nền tảng để cung cấp Phần phụ thuộc . Nói chung, getAuth
là cách dễ nhất để khởi tạo Auth và hoạt động trong hầu hết các trường hợp sử dụng. Sử dụng initializeAuth
nếu bạn cần kiểm soát lớp lưu giữ nào được sử dụng hoặc để giảm thiểu kích thước gói nếu bạn không sử dụng signInWithPopup
hoặc signInWithRedirect
.
Ví dụ: nếu ứng dụng của bạn chỉ sử dụng tài khoản ẩn danh và bạn chỉ muốn lưu tài khoản cho phiên hiện tại, hãy khởi tạo Auth
bằng:
const auth = initializeAuth(app, {
persistence: browserSessionPersistence,
popupRedirectResolver: undefined,
});
Chữ ký:
export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
ứng dụng | Ứng dụng Firebase | |
phụ thuộc | phụ thuộc |
Trả về:
chức năng (lưu trữ, ...)
getReactNativePersistence(lưu trữ)
Trả về một đối tượng bền vững bao bọc AsyncStorage
được nhập từ react-native
hoặc @react-native-community/async-storage
và có thể được sử dụng trong trường phụ thuộc kiên trì trong initizeAuth() .
Chữ ký:
export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
kho | ReactNativeAsyncStorage |
Trả về:
hàm (xác thực, ...)
applyActionCode(auth, oobCode)
Áp dụng mã xác minh được gửi cho người dùng qua email hoặc cơ chế ngoài phạm vi khác.
Chữ ký:
export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
mã oob | sợi dây | Mã xác minh được gửi tới người dùng. |
Trả về:
Hứa<void>
beforeAuthStateChanged(auth, gọi lại, onAbort)
Thêm lệnh gọi lại chặn chạy trước khi thay đổi trạng thái xác thực sẽ đặt người dùng mới.
Chữ ký:
export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
gọi lại | (người dùng: Người dùng | null) => void | Hứa<void> | gọi lại được kích hoạt trước khi giá trị người dùng mới được đặt. Nếu điều này xảy ra, nó sẽ chặn người dùng được thiết lập. |
hủy bỏ | () => vô hiệu | lệnh gọi lại được kích hoạt nếu lệnh gọi lại beforeAuthStateChanged() sau đó được thực hiện, cho phép bạn hoàn tác mọi tác dụng phụ. |
Trả về:
checkActionCode(auth, oobCode)
Kiểm tra mã xác minh được gửi cho người dùng qua email hoặc cơ chế ngoài băng tần khác.
Chữ ký:
export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
mã oob | sợi dây | Mã xác minh được gửi tới người dùng. |
Trả về:
Lời hứa< ActionCodeInfo >
siêu dữ liệu về mã.
confirmPasswordReset(auth, oobCode, newPassword)
Hoàn tất quá trình đặt lại mật khẩu, được cung cấp mã xác nhận và mật khẩu mới.
Chữ ký:
export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
mã oob | sợi dây | Mã xác nhận được gửi tới người dùng. |
mật khẩu mới | sợi dây | Mật khẩu mới. |
Trả về:
Hứa<void>
connectAuthEmulator(auth, url, tùy chọn)
Thay đổi phiên bản Auth để giao tiếp với Trình mô phỏng xác thực Firebase, thay vì sản xuất các dịch vụ Xác thực Firebase.
Điều này phải được gọi một cách đồng bộ ngay sau lệnh gọi đầu tiên tới initizeAuth() . Không sử dụng bằng thông tin xác thực sản xuất vì lưu lượng mô phỏng không được mã hóa.
Chữ ký:
export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
disableWarnings: boolean;
}): void;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
địa chỉ | sợi dây | URL mà trình mô phỏng đang chạy (ví dụ: 'http://localhost:9099'). |
tùy chọn | { vô hiệu hóaWarnings: boolean; } | Không bắt buộc. options.disableWarnings mặc định là false . Đặt giá trị này thành true để tắt biểu ngữ cảnh báo được đính kèm với DOM. |
Trả về:
trống rỗng
Ví dụ
connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });
createUserWithEmailAndPassword(auth, email, mật khẩu)
Tạo một tài khoản người dùng mới được liên kết với địa chỉ email và mật khẩu được chỉ định.
Khi tạo thành công tài khoản người dùng, người dùng này cũng sẽ đăng nhập vào ứng dụng của bạn.
Việc tạo tài khoản người dùng có thể không thành công nếu tài khoản đã tồn tại hoặc mật khẩu không hợp lệ.
Chữ ký:
export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
sợi dây | Địa chỉ email của người dùng. | |
mật khẩu | sợi dây | Mật khẩu do người dùng chọn. |
Trả về:
Lời hứa< Thông tin người dùng >
tìm nạpSignInMethodsForEmail(auth, email)
Lấy danh sách các phương thức đăng nhập có thể áp dụng cho địa chỉ email đã cho. Phương thức này trả về một danh sách trống khi [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật, bất kể số lượng phương thức xác thực có sẵn cho email đã cho.
Điều này hữu ích để phân biệt các phương thức đăng nhập cho cùng một nhà cung cấp, ví dụ: EmailAuthProvider có 2 phương thức đăng nhập, SignInMethod .EMAIL_PASSWORD và Phương thức đăng nhập .LIÊN KẾT EMAIL.
Chữ ký:
export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
sợi dây | Địa chỉ email của người dùng. Không dùng nữa. Việc di chuyển khỏi phương pháp này được khuyến nghị là phương pháp bảo mật tốt nhất. Tìm hiểu thêm trong tài liệu Nền tảng nhận dạng về [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection). |
Trả về:
Lời hứa<string[]>
getMultiFactorResolver(xác thực, lỗi)
Cung cấp MultiFactorResolver phù hợp để hoàn thành quy trình đa yếu tố.
Chữ ký:
export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
lỗi | Lỗi đa yếu tố | MultiFactorError xuất hiện trong quá trình đăng nhập hoặc hoạt động xác thực lại. |
Trả về:
getRedirectResult(xác thực, trình phân giải)
Trả về UserCredential từ luồng đăng nhập dựa trên chuyển hướng.
Nếu đăng nhập thành công, trả về người dùng đã đăng nhập. Nếu đăng nhập không thành công, có lỗi. Nếu không có thao tác chuyển hướng nào được gọi, trả về null
.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
người giải quyết | PopupRedirectResolver | Một phiên bản của PopupRedirectResolver , tùy chọn nếu đã được cung cấp cho initizeAuth() hoặc được cung cấp bởi getAuth() . |
Trả về:
Hứa < Thông tin người dùng | vô giá trị>
Ví dụ
// 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;
khởi tạoRecaptchaConfig(auth)
Tải cấu hình reCAPTCHA vào phiên bản Auth
.
Thao tác này sẽ tải cấu hình reCAPTCHA, cho biết liệu luồng xác minh reCAPTCHA có nên được kích hoạt cho từng nhà cung cấp dịch vụ xác thực vào phiên Auth hiện tại hay không.
Nếu initizeRecaptchaConfig() không được gọi thì luồng xác thực sẽ luôn bắt đầu mà không cần xác minh reCAPTCHA. Nếu nhà cung cấp được định cấu hình để yêu cầu xác minh reCAPTCHA thì SDK sẽ tải cấu hình reCAPTCHA một cách minh bạch và khởi động lại các luồng xác thực.
Do đó, bằng cách gọi phương thức tùy chọn này, bạn sẽ giảm độ trễ của các luồng xác thực trong tương lai. Việc tải cấu hình reCAPTCHA sớm cũng sẽ tăng cường tín hiệu do reCAPTCHA thu thập.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
Trả về:
Hứa<void>
Ví dụ
initializeRecaptchaConfig(auth);
isSignInWithEmailLink(auth, emailLink)
Kiểm tra xem liên kết đến có phải là liên kết đăng nhập bằng liên kết email phù hợp cho signInWithEmailLink() không .
Chữ ký:
export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
liên kết email | sợi dây | Liên kết được gửi đến địa chỉ email của người dùng. |
Trả về:
boolean
onAuthStateChanged(auth, nextOrObserver, lỗi, đã hoàn thành)
Thêm người quan sát những thay đổi đối với trạng thái đăng nhập của người dùng.
Để giữ hành vi cũ, hãy xem onIdTokenChanged() .
Chữ ký:
export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
tiếp theoHoặcObserver | Tiếp theoHoặcObserver < Người dùng > | gọi lại được kích hoạt khi thay đổi. |
lỗi | LỗiFn | Không dùng nữa. Cuộc gọi lại này không bao giờ được kích hoạt. Lỗi khi đăng nhập/đăng xuất có thể xảy ra trong các lời hứa được trả về từ chức năng đăng nhập/đăng xuất. |
hoàn thành | Hoàn thànhFn | Không dùng nữa. Cuộc gọi lại này không bao giờ được kích hoạt. |
Trả về:
onIdTokenChanged(auth, nextOrObserver, lỗi, đã hoàn thành)
Thêm người quan sát những thay đổi đối với mã thông báo ID của người dùng đã đăng nhập.
Điều này bao gồm các sự kiện đăng nhập, đăng xuất và làm mới mã thông báo. Điều này sẽ không được kích hoạt tự động khi hết hạn mã thông báo ID. Sử dụng User.getIdToken() để làm mới mã thông báo ID.
Chữ ký:
export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
tiếp theoHoặcObserver | Tiếp theoHoặcObserver < Người dùng > | gọi lại được kích hoạt khi thay đổi. |
lỗi | LỗiFn | Không dùng nữa. Cuộc gọi lại này không bao giờ được kích hoạt. Lỗi khi đăng nhập/đăng xuất có thể xảy ra trong các lời hứa được trả về từ chức năng đăng nhập/đăng xuất. |
hoàn thành | Hoàn thànhFn | Không dùng nữa. Cuộc gọi lại này không bao giờ được kích hoạt. |
Trả về:
thu hồiAccessToken(auth, token)
Thu hồi mã thông báo truy cập đã cho. Hiện chỉ hỗ trợ mã thông báo truy cập OAuth của Apple.
Chữ ký:
export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
mã thông báo | sợi dây | Mã thông báo truy cập OAuth của Apple. |
Trả về:
Hứa<void>
sendPasswordResetEmail(auth, email, actionCodeSettings)
Gửi email đặt lại mật khẩu đến địa chỉ email đã cho. Phương pháp này không gây ra lỗi khi không có tài khoản người dùng nào có địa chỉ email đã cho và [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật .
Để hoàn tất việc đặt lại mật khẩu, hãy gọi confirmPasswordReset() bằng mã được cung cấp trong email gửi cho người dùng, cùng với mật khẩu mới do người dùng chỉ định.
Chữ ký:
export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
sợi dây | Địa chỉ email của người dùng. | |
hành độngCodeSettings | Cài đặt mã hành động | Cài đặt mã hành động . |
Trả về:
Hứa<void>
Ví dụ
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)
Gửi liên kết email đăng nhập tới người dùng bằng email được chỉ định.
Thao tác đăng nhập phải luôn được hoàn thành trong ứng dụng, không giống như các hành động email khác ngoài nhóm (đặt lại mật khẩu và xác minh email). Điều này là do ở cuối quy trình, người dùng dự kiến sẽ đăng nhập và trạng thái Xác thực của họ vẫn tồn tại trong ứng dụng.
Để hoàn tất đăng nhập bằng liên kết email, hãy gọi signInWithEmailLink() bằng địa chỉ email và liên kết email được cung cấp trong email gửi cho người dùng.
Chữ ký:
export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | |
sợi dây | Địa chỉ email của người dùng. | |
hành độngCodeSettings | Cài đặt mã hành động | Cài đặt mã hành động . |
Trả về:
Hứa<void>
Ví dụ
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, kiên trì)
Thay đổi loại lưu giữ trên phiên bản Auth cho phiên Auth
hiện đã lưu và áp dụng loại lưu giữ này cho các yêu cầu đăng nhập trong tương lai, bao gồm cả đăng nhập bằng yêu cầu chuyển hướng.
Điều này giúp người dùng đăng nhập dễ dàng chỉ định liệu phiên của họ có được ghi nhớ hay không. Nó cũng giúp việc không bao giờ duy trì trạng thái Auth
đối với các ứng dụng được người dùng khác chia sẻ hoặc có dữ liệu nhạy cảm trở nên dễ dàng hơn.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
kiên trì | Kiên trì | Sự kiên trì để sử dụng. |
Trả về:
Hứa<void>
Promise
sẽ được giải quyết sau khi quá trình thay đổi liên tục hoàn tất
Ví dụ
setPersistence(auth, browserSessionPersistence);
signInAnonymous(auth)
Đăng nhập không đồng bộ với tư cách là người dùng ẩn danh.
Nếu đã có người dùng ẩn danh đăng nhập, người dùng đó sẽ được trả về; nếu không, danh tính người dùng ẩn danh mới sẽ được tạo và trả về.
Chữ ký:
export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
Trả về:
Lời hứa< Thông tin người dùng >
signInWithCredential(auth, thông tin xác thực)
Đăng nhập không đồng bộ bằng thông tin đăng nhập đã cho.
Có thể sử dụng AuthProvider để tạo thông tin xác thực.
Chữ ký:
export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
chứng chỉ | Thông tin xác thực | Thông tin xác thực. |
Trả về:
Lời hứa< Thông tin người dùng >
signInWithCustomToken(auth, customToken)
Đăng nhập không đồng bộ bằng cách sử dụng mã thông báo tùy chỉnh.
Mã thông báo tùy chỉnh được sử dụng để tích hợp Firebase Auth với các hệ thống xác thực hiện có và phải được tạo bởi chương trình phụ trợ xác thực bằng phương thức createCustomToken trong SDK quản trị .
Không thành công nếu mã thông báo không hợp lệ, hết hạn hoặc không được dịch vụ Firebase Auth chấp nhận.
Chữ ký:
export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
tùy chỉnhToken | sợi dây | Mã thông báo tùy chỉnh để đăng nhập. |
Trả về:
Lời hứa< Thông tin người dùng >
signInWithEmailAndPassword(auth, email, mật khẩu)
Đăng nhập không đồng bộ bằng email và mật khẩu.
Không thành công nếu địa chỉ email và mật khẩu không khớp. Khi [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật, phương thức này sẽ không thành công với "auth/invalid-credential" trong trường hợp thông tin xác thực không hợp lệ email/mật khẩu.
Chữ ký:
export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
sợi dây | Địa chỉ email của người dùng. | |
mật khẩu | sợi dây | Mật khẩu người dùng. |
Trả về:
Lời hứa< Thông tin người dùng >
signInWithEmailLink(auth, email, emailLink)
Đăng nhập không đồng bộ bằng email và liên kết email đăng nhập.
Nếu không có liên kết nào được thông qua, liên kết sẽ được suy ra từ URL hiện tại.
Không thành công nếu địa chỉ email không hợp lệ hoặc OTP trong liên kết email hết hạn.
Chữ ký:
export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
sợi dây | Địa chỉ email của người dùng. | |
liên kết email | sợi dây | Liên kết được gửi đến địa chỉ email của người dùng. |
Trả về:
Lời hứa< Thông tin người dùng >
Ví dụ
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)
Đăng nhập không đồng bộ bằng cách sử dụng số điện thoại.
Phương thức này gửi mã qua SMS đến số điện thoại đã cho và trả về Kết quả xác nhận . Sau khi người dùng cung cấp mã được gửi tới điện thoại của họ, hãy gọi ConfirmationResult.confirm() kèm theo mã để đăng nhập người dùng.
Để ngăn chặn lạm dụng, phương pháp này cũng yêu cầu Trình xác minh ứng dụng . SDK này bao gồm triển khai dựa trên reCAPTCHA, RecaptchaVerifier . Chức năng này có thể hoạt động trên các nền tảng khác không hỗ trợ RecaptchaVerifier (như React Native), nhưng bạn cần sử dụng triển khai ApplicationVerifier của bên thứ ba.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
số điện thoại | sợi dây | Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101). |
trình xác minh ứng dụng | Trình xác minh ứng dụng | Trình xác minh ứng dụng . |
Trả về:
Lời hứa< Xác nhậnKết quả >
Ví dụ
// '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, nhà cung cấp, trình phân giải)
Xác thực ứng dụng khách Firebase bằng luồng xác thực OAuth dựa trên cửa sổ bật lên.
Nếu thành công, trả về người dùng đã đăng nhập cùng với thông tin xác thực của nhà cung cấp. Nếu đăng nhập không thành công, trả về đối tượng lỗi chứa thông tin bổ sung về lỗi.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
các nhà cung cấp | Nhà cung cấp xác thực | Nhà cung cấp để xác thực. Nhà cung cấp phải là OAuthProvider . Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ báo lỗi. |
người giải quyết | PopupRedirectResolver | Một phiên bản của PopupRedirectResolver , tùy chọn nếu đã được cung cấp cho initizeAuth() hoặc được cung cấp bởi getAuth() . |
Trả về:
Lời hứa< Thông tin người dùng >
Ví dụ
// 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, nhà cung cấp, trình phân giải)
Xác thực ứng dụng khách Firebase bằng luồng chuyển hướng toàn trang.
Để xử lý kết quả và lỗi của thao tác này, hãy tham khảo getRedirectResult() . Thực hiện theo các phương pháp hay nhất khi sử dụng signInWithRedirect() .
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
các nhà cung cấp | Nhà cung cấp xác thực | Nhà cung cấp để xác thực. Nhà cung cấp phải là OAuthProvider . Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ báo lỗi. |
người giải quyết | PopupRedirectResolver | Một phiên bản của PopupRedirectResolver , tùy chọn nếu đã được cung cấp cho initizeAuth() hoặc được cung cấp bởi getAuth() . |
Trả về:
Hứa<không bao giờ>
Ví dụ
// 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)
Đăng xuất người dùng hiện tại.
Chữ ký:
export declare function signOut(auth: Auth): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
Trả về:
Hứa<void>
updateCurrentUser(auth, user)
Đặt không đồng bộ người dùng được cung cấp làm Auth.currentUser trên phiên bản Auth .
Một bản sao phiên bản mới của người dùng được cung cấp sẽ được tạo và đặt là Người dùng hiện tại.
Điều này sẽ kích hoạt trình nghe onAuthStateChanged() và onIdTokenChanged() giống như các phương thức đăng nhập khác.
Thao tác không thành công và có lỗi nếu người dùng được cập nhật thuộc dự án Firebase khác.
Chữ ký:
export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
người dùng | Người dùng | vô giá trị | Người dùng mới . |
Trả về:
Hứa<void>
useDeviceLanguage(auth)
Đặt ngôn ngữ hiện tại thành tùy chọn thiết bị/trình duyệt mặc định.
Chữ ký:
export declare function useDeviceLanguage(auth: Auth): void;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
Trả về:
trống rỗng
xác thựcPassword(xác thực, mật khẩu)
Xác thực mật khẩu theo chính sách mật khẩu được định cấu hình cho dự án hoặc đối tượng thuê.
Nếu không có ID đối tượng thuê nào được đặt trên phiên bản Auth
thì phương thức này sẽ sử dụng chính sách mật khẩu được định cấu hình cho dự án. Nếu không, phương pháp này sẽ sử dụng chính sách được định cấu hình cho đối tượng thuê. Nếu chính sách mật khẩu chưa được cấu hình thì chính sách mặc định được cấu hình cho tất cả các dự án sẽ được sử dụng.
Nếu luồng xác thực không thành công do mật khẩu đã gửi không đáp ứng các yêu cầu về chính sách mật khẩu và phương thức này đã được gọi trước đó thì phương thức này sẽ sử dụng chính sách gần đây nhất hiện có khi được gọi lại.
Chữ ký:
export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
mật khẩu | sợi dây | Mật khẩu để xác nhận. |
Trả về:
Lời hứa< Trạng thái xác thực mật khẩu >
Ví dụ
validatePassword(auth, 'some-password');
verifyPasswordResetCode(auth, code)
Kiểm tra mã đặt lại mật khẩu được gửi cho người dùng qua email hoặc cơ chế ngoài băng tần khác.
Chữ ký:
export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
xác thực | Xác thực | Ví dụ Auth . |
mã số | sợi dây | Mã xác minh được gửi tới người dùng. |
Trả về:
Hứa<string>
địa chỉ email của người dùng nếu hợp lệ.
chức năng (liên kết, ...)
phân tích cú phápActionCodeURL(liên kết)
Phân tích chuỗi liên kết hành động email và trả về ActionCodeURL nếu liên kết hợp lệ, nếu không thì trả về giá trị rỗng.
Chữ ký:
export declare function parseActionCodeURL(link: string): ActionCodeURL | null;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
liên kết | sợi dây |
Trả về:
Mã hành độngURL | vô giá trị
chức năng (người dùng, ...)
xóaNgười dùng(người dùng)
Xóa và đăng xuất người dùng.
Chữ ký:
export declare function deleteUser(user: User): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
Trả về:
Hứa<void>
getIdToken(người dùng, ForceRefresh)
Trả về Mã thông báo web JSON (JWT) được sử dụng để nhận dạng người dùng cho dịch vụ Firebase.
Trả về mã thông báo hiện tại nếu nó chưa hết hạn hoặc nếu nó không hết hạn trong năm phút tới. Nếu không, thao tác này sẽ làm mới mã thông báo và trả về mã mới.
Chữ ký:
export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
lực lượngLàm mới | boolean | Buộc làm mới bất kể mã thông báo hết hạn. |
Trả về:
Hứa<string>
getIdTokenResult(người dùng, ForceRefresh)
Trả về Mã thông báo web JSON đã được khử tuần tự hóa (JWT) được sử dụng để nhận dạng người dùng cho dịch vụ Firebase.
Trả về mã thông báo hiện tại nếu nó chưa hết hạn hoặc nếu nó không hết hạn trong năm phút tới. Nếu không, thao tác này sẽ làm mới mã thông báo và trả về mã mới.
Chữ ký:
export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
lực lượngLàm mới | boolean | Buộc làm mới bất kể mã thông báo hết hạn. |
Trả về:
Lời hứa< IdTokenResult >
linkWithCredential(người dùng, thông tin xác thực)
Liên kết tài khoản người dùng với thông tin xác thực nhất định.
Có thể sử dụng AuthProvider để tạo thông tin xác thực.
Chữ ký:
export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
chứng chỉ | Thông tin xác thực | Thông tin xác thực. |
Trả về:
Lời hứa< Thông tin người dùng >
linkWithPhoneNumber(người dùng, số điện thoại, appVerifier)
Liên kết tài khoản người dùng với số điện thoại nhất định.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
số điện thoại | sợi dây | Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101). |
trình xác minh ứng dụng | Trình xác minh ứng dụng | Trình xác minh ứng dụng . |
Trả về:
Lời hứa< Xác nhậnKết quả >
linkWithPopup(người dùng, nhà cung cấp, trình phân giải)
Liên kết nhà cung cấp được xác thực với tài khoản người dùng bằng luồng OAuth dựa trên cửa sổ bật lên.
Nếu liên kết thành công, kết quả trả về sẽ chứa thông tin xác thực của người dùng và nhà cung cấp.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
các nhà cung cấp | Nhà cung cấp xác thực | Nhà cung cấp để xác thực. Nhà cung cấp phải là OAuthProvider . Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ báo lỗi. |
người giải quyết | PopupRedirectResolver | Một phiên bản của PopupRedirectResolver , tùy chọn nếu đã được cung cấp cho initizeAuth() hoặc được cung cấp bởi getAuth() . |
Trả về:
Lời hứa< Thông tin người dùng >
Ví dụ
// 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(người dùng, nhà cung cấp, trình phân giải)
Liên kết OAuthProvider với tài khoản người dùng bằng luồng chuyển hướng toàn trang.
Để xử lý kết quả và lỗi của thao tác này, hãy tham khảo getRedirectResult() . Thực hiện theo các phương pháp hay nhất khi sử dụng linkWithRedirect() .
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
các nhà cung cấp | Nhà cung cấp xác thực | Nhà cung cấp để xác thực. Nhà cung cấp phải là OAuthProvider . Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ báo lỗi. |
người giải quyết | PopupRedirectResolver | Một phiên bản của PopupRedirectResolver , tùy chọn nếu đã được cung cấp cho initizeAuth() hoặc được cung cấp bởi getAuth() . |
Trả về:
Hứa<không bao giờ>
Ví dụ
// 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);
đa yếu tố (người dùng)
MultiFactorUser tương ứng với người dùng.
Điều này được sử dụng để truy cập tất cả các thuộc tính và hoạt động đa yếu tố liên quan đến người dùng.
Chữ ký:
export declare function multiFactor(user: User): MultiFactorUser;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
Trả về:
xác thực lạiWithCredential(người dùng, thông tin xác thực)
Xác thực lại người dùng bằng thông tin xác thực mới.
Sử dụng trước các hoạt động như updatePassword() yêu cầu mã thông báo từ các lần đăng nhập gần đây. Phương pháp này có thể được sử dụng để khôi phục từ lỗi CREDENTIAL_TOO_OLD_LOGIN_AGAIN
hoặc lỗi TOKEN_EXPIRED
.
Chữ ký:
export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
chứng chỉ | Thông tin xác thực | Thông tin xác thực. |
Trả về:
Lời hứa< Thông tin người dùng >
xác thực lạiWithPhoneNumber(người dùng, số điện thoại, appVerifier)
Xác thực lại người dùng bằng thông tin xác thực điện thoại mới.
Sử dụng trước các hoạt động như updatePassword() yêu cầu mã thông báo từ các lần đăng nhập gần đây.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
số điện thoại | sợi dây | Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101). |
trình xác minh ứng dụng | Trình xác minh ứng dụng | Trình xác minh ứng dụng . |
Trả về:
Lời hứa< Xác nhậnKết quả >
xác thực lạiWithPopup(người dùng, nhà cung cấp, trình phân giải)
Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng luồng OAuth dựa trên cửa sổ bật lên.
Nếu xác thực lại thành công, kết quả trả về sẽ chứa thông tin xác thực của người dùng và nhà cung cấp.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
các nhà cung cấp | Nhà cung cấp xác thực | Nhà cung cấp để xác thực. Nhà cung cấp phải là OAuthProvider . Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ báo lỗi. |
người giải quyết | PopupRedirectResolver | Một phiên bản của PopupRedirectResolver , tùy chọn nếu đã được cung cấp cho initizeAuth() hoặc được cung cấp bởi getAuth() . |
Trả về:
Lời hứa< Thông tin người dùng >
Ví dụ
// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);
xác thực lạiWithRedirect(người dùng, nhà cung cấp, trình phân giải)
Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng luồng chuyển hướng toàn trang.
Để xử lý kết quả và lỗi của thao tác này, hãy tham khảo getRedirectResult() . Thực hiện theo các phương pháp hay nhất khi sử dụng reauthenticateWithRedirect() .
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
các nhà cung cấp | Nhà cung cấp xác thực | Nhà cung cấp để xác thực. Nhà cung cấp phải là OAuthProvider . Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ báo lỗi. |
người giải quyết | PopupRedirectResolver | Một phiên bản của PopupRedirectResolver , tùy chọn nếu đã được cung cấp cho initizeAuth() hoặc được cung cấp bởi getAuth() . |
Trả về:
Hứa<không bao giờ>
Ví dụ
// 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);
tải lại (người dùng)
Tải lại dữ liệu tài khoản người dùng, nếu đăng nhập.
Chữ ký:
export declare function reload(user: User): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
Trả về:
Hứa<void>
sendEmailVerification(người dùng, actionCodeSettings)
Gửi email xác minh cho người dùng.
Quá trình xác minh được hoàn thành bằng cách gọi applyActionCode() .
Chữ ký:
export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
hành độngCodeSettings | Cài đặt mã hành động | vô giá trị | Cài đặt mã hành động . |
Trả về:
Hứa<void>
Ví dụ
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);
hủy liên kết(người dùng, nhà cung cấpId)
Hủy liên kết nhà cung cấp khỏi tài khoản người dùng.
Chữ ký:
export declare function unlink(user: User, providerId: string): Promise<User>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
id nhà cung cấp | sợi dây | Nhà cung cấp hủy liên kết. |
Trả về:
Lời hứa< Người dùng >
updateEmail(người dùng, email mới)
Cập nhật địa chỉ email của người dùng.
Một email sẽ được gửi đến địa chỉ email ban đầu (nếu nó đã được đặt) cho phép thu hồi thay đổi địa chỉ email, nhằm bảo vệ họ khỏi bị chiếm đoạt tài khoản.
Chữ ký:
export declare function updateEmail(user: User, newEmail: string): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
Email mới | sợi dây | Địa chỉ email mới. Đưa ra lỗi "xác thực/không được phép hoạt động" khi [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật. Không được dùng nữa - thay vào đó hãy sử dụng verifyBeforeUpdateEmail() . |
Trả về:
Hứa<void>
updatePassword(người dùng, newPassword)
Cập nhật mật khẩu của người dùng.
Chữ ký:
export declare function updatePassword(user: User, newPassword: string): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
mật khẩu mới | sợi dây | Mật khẩu mới. |
Trả về:
Hứa<void>
updatePhoneNumber(người dùng, thông tin xác thực)
Cập nhật số điện thoại của người dùng.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
chứng chỉ | Thông tin xác thực điện thoại | Thông tin xác thực xác thực số điện thoại mới. |
Trả về:
Hứa<void>
Ví dụ
// '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(người dùng, { displayName, photoURL: photoUrl })
Cập nhật dữ liệu hồ sơ của người dùng.
Chữ ký:
export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
displayName?: string | null;
photoURL?: string | null;
}): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
{ displayName, photoURL: photoUrl } | {tên hiển thị?: chuỗi | vô giá trị; photoURL?: chuỗi | vô giá trị; } |
Trả về:
Hứa<void>
verifyBeforeUpdateEmail(người dùng, email mới, actionCodeSettings)
Gửi email xác minh đến địa chỉ email mới.
Email của người dùng sẽ được cập nhật sang email mới sau khi được xác minh.
Nếu bạn có trình xử lý hành động email tùy chỉnh, bạn có thể hoàn tất quy trình xác minh bằng cách gọi applyActionCode() .
Chữ ký:
export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Người dùng | Người dùng. |
Email mới | sợi dây | Địa chỉ email mới sẽ được xác minh trước khi cập nhật. |
hành độngCodeSettings | Cài đặt mã hành động | vô giá trị | Cài đặt mã hành động . |
Trả về:
Hứa<void>
Ví dụ
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);
chức năng (thông tin người dùng, ...)
getAdditionalUserInfo(userCredential)
Trích xuất Thông tin người dùng bổ sung cụ thể của nhà cung cấp cho thông tin xác thực nhất định.
Chữ ký:
export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
thông tin người dùng | Thông tin người dùng | Thông tin xác thực của người dùng. |
Trả về:
Thông tin người dùng bổ sung | vô giá trị
Mã hành độngHoạt động
Một bảng liệt kê các loại hành động email có thể có.
Chữ ký:
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";
}
Mã lỗi xác thực
Bản đồ các mã lỗi Auth
thực tiềm ẩn để dễ dàng so sánh hơn với các lỗi do SDK đưa ra.
Lưu ý rằng bạn không thể rung cây từng phím riêng lẻ trên bản đồ, do đó, bằng cách sử dụng bản đồ, bạn có thể tăng đáng kể kích thước gói của mình.
Chữ ký:
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";
}
trình duyệtLocalPersistence
Việc triển khai Persistence thuộc loại LOCAL
bằng cách sử dụng localStorage
cho bộ lưu trữ cơ bản.
Chữ ký:
browserLocalPersistence: Persistence
trình duyệtPopupRedirectResolver
Việc triển khai PopupRedirectResolver phù hợp cho các ứng dụng dựa trên trình duyệt.
Phương pháp này không hoạt động trong môi trường Node.js.
Chữ ký:
browserPopupRedirectResolver: PopupRedirectResolver
trình duyệtSessionPersistence
Việc triển khai Tính bền vững của SESSION
bằng cách sử dụng sessionStorage
cho bộ lưu trữ cơ bản.
Chữ ký:
browserSessionPersistence: Persistence
cordovaPopupRedirectResolver
Việc triển khai PopupRedirectResolver phù hợp với các ứng dụng dựa trên Cordova.
Chữ ký:
cordovaPopupRedirectResolver: PopupRedirectResolver
gỡ lỗiErrorMap
Bản đồ lỗi chi tiết với mô tả chi tiết cho hầu hết các mã lỗi.
Xem thảo luận tại AuthErrorMap
Chữ ký:
debugErrorMap: AuthErrorMap
Id yếu tố
Một danh sách các yếu tố có thể được sử dụng để xác thực đa yếu tố.
Chữ ký:
FactorId: {
readonly PHONE: "phone";
readonly TOTP: "totp";
}
được lập chỉ mụcDBLocalPersistence
Việc triển khai Persistence thuộc loại LOCAL
bằng cách sử dụng indexedDB
cho bộ lưu trữ cơ bản.
Chữ ký:
indexedDBLocalPersistence: Persistence
inMemoryPersistence
Việc triển khai Persistence thuộc loại 'NONE'.
Chữ ký:
inMemoryPersistence: Persistence
Loại hoạt động
Liệt kê các loại hoạt động được hỗ trợ.
Chữ ký:
OperationType: {
readonly LINK: "link";
readonly REAUTHENTICATE: "reauthenticate";
readonly SIGN_IN: "signIn";
}
bản đồ lỗi sản phẩm
Bản đồ lỗi tối thiểu với tất cả các thông báo lỗi dài dòng bị loại bỏ.
Xem thảo luận tại AuthErrorMap
Chữ ký:
prodErrorMap: AuthErrorMap
Id nhà cung cấp
Danh sách các nhà cung cấp được hỗ trợ.
Chữ ký:
ProviderId: {
readonly FACEBOOK: "facebook.com";
readonly GITHUB: "github.com";
readonly GOOGLE: "google.com";
readonly PASSWORD: "password";
readonly PHONE: "phone";
readonly TWITTER: "twitter.com";
}
Phương thức đăng nhập
Liệt kê các phương thức đăng nhập được hỗ trợ.
Chữ ký:
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";
}
Thông số tùy chỉnh
Bản đồ các thông số tùy chỉnh OAuth.
Chữ ký:
export declare type CustomParameters = Record<string, string>;
Tiếp theoHoặcObserver
Định nghĩa loại cho một cuộc gọi lại sự kiện.
Chữ ký:
export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
Tùy chọn thông tin điện thoại
Thông tin cần thiết để xác minh quyền sở hữu số điện thoại.
Thông tin được yêu cầu tùy thuộc vào việc bạn đang thực hiện đăng nhập một yếu tố, đăng ký nhiều yếu tố hay đăng nhập nhiều yếu tố.
Chữ ký:
export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;
Thông tin người dùng
Hồ sơ người dùng được sử dụng trong AddedUserInfo .
Chữ ký:
export declare type UserProfile = Record<string, unknown>;