auth package

Xác thực Firebase

Hàm

Hàm Nội dung mô tả
hàm(ứng dụng, ...)
getAuth(app) Trả về thực thể Xác thực được liên kết với FirebaseApp đã cung cấp. Nếu không có thực thể nào tồn tại, hãy khởi chạy một thực thể Auth với các phần phụ thuộc mặc định dành riêng cho nền tảng.
initializeAuth(app, deps) Khởi động một thực thể Auth với quyền kiểm soát chi tiết đối với Phần phụ thuộc.
hàm(storage, ...)
getReactNativePersistence(storage) Trả về một đối tượng cố định bao bọc AsyncStorage được nhập từ react-native hoặc @react-native-community/async-storage. Đối tượng này có thể dùng trong trường phần phụ thuộc lưu trữ cố định trong initializeAuth().
hàm(auth, ...)
applyActionCode(auth, oobCode) Áp dụng mã xác minh gửi cho người dùng qua email hoặc cơ chế ngoài băng tần khác.
beforeAuthStateChanged(auth, callback, 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, options) Thay đổi thực thể Auth để giao tiếp với Trình mô phỏng xác thực Firebase, thay vì các dịch vụ Xác thực Firebase chính thức.
createUserWithEmailAndPassword(auth, email, password) 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 đã chỉ định.
fetchSignInMethodsForEmail(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 [Tính năng bảo vệ danh sách 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(auth, error) Cung cấp một MultiFactorResolver phù hợp để hoàn tất quy trình đa yếu tố.
getRedirectResult(auth, resolver) Trả về UserCredential trong quy trình đăng nhập dựa trên lệnh chuyển hướng.
initializeRecaptchaConfig(auth) Tải cấu hình reCAPTCHA vào thực thể Auth.
isSignInWithEmailLink(auth, emailLink) Kiểm tra xem đường liên kết đến có phải là đường liên kết đăng nhập bằng đường liên kết email phù hợp với signInWithEmailLink() hay không.
onAuthStateChanged(auth, nextOrObserver, error, completed) Thêm trình quan sát đối với các thay đổi đối với trạng thái đăng nhập của người dùng.
onIdTokenChanged(auth, nextOrObserver, error, completed) Thêm trình quan sát đối với các thay đổi đối với mã thông báo mã nhận dạng của người dùng đã đăng nhập.
revokeAccessToken(auth, token) Thu hồi mã truy cập đã cấp. Hiện chỉ hỗ trợ mã 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 đã chỉ định. Phương thức 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à tính năng [Bảo vệ tính năng liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật.
sendSignInLinkToEmail(auth, email, actionCodeSettings) Gửi đường liên kết email đăng nhập cho người dùng bằng email được chỉ định.
setPersistence(auth, persistence) Thay đổi kiểu lưu trữ cố định trên thực thể Auth (Xác thực) cho phiên Auth hiện đã lưu và áp dụng kiểu lưu trữ này cho các yêu cầu đăng nhập sau này, bao gồm cả hoạt động đăng nhập bằng yêu cầu chuyển hướng.
signInAnonymously(auth) Đăng nhập không đồng bộ với tư cách người dùng ẩn danh.
signInWithCredential(auth, credential) Đă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 mã thông báo tuỳ chỉnh.
signInWithEmailAndPassword(auth, email, password) Đă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à đường liên kết đăng nhập qua email.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) Đăng nhập không đồng bộ bằng số điện thoại.
signInWithPopup(auth, provider, resolver) Xác thực ứng dụng Firebase bằng quy trình xác thực OAuth dựa trên cửa sổ bật lên.
signInWithRedirect(auth, provider, resolver) Xác thực ứng dụng Firebase bằng quy trình chuyển hướng toàn trang.
signOut(auth) Đăng xuất người dùng hiện tại.
updateCurrentUser(auth, user) Đặt người dùng được cung cấp là Auth.currentUser một cách không đồng bộ trên thực thể Auth.
useDeviceLanguage(auth) Đặt ngôn ngữ hiện tại thành tuỳ chọn thiết bị/trình duyệt mặc định.
validatePassword(auth, password) Xác thực mật khẩu dựa trên 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.
hàm(link, ...)
parseActionCodeURL(đường liên kết) Phân tích cú pháp chuỗi liên kết thao tác gửi email và trả về ActionCodeURL nếu đường liên kết hợp lệ, nếu không thì sẽ trả về giá trị rỗng.
hàm(user, ...)
deleteUser(user) Xoá và đăng xuất người dùng.
getIdToken(user, forceRefresh) Trả về một mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho một dịch vụ Firebase.
getIdTokenResult(user, forceRefresh) Trả về mã thông báo web JSON đã giải tuần tự (JWT) được dùng để xác định người dùng cho một dịch vụ Firebase.
linkWithCredential(user, credential) Liên kết tài khoản người dùng với thông tin đăng nhập đã cho.
linkWithPhoneNumber(user, phoneNumber, appVerifier) Liên kết tài khoản người dùng với số điện thoại đã cho.
linkWithPopup(user, provider, resolver) Liên kết trình cung cấp đã xác thực với tài khoản người dùng bằng quy trình OAuth dựa trên cửa sổ bật lên.
linkWithRedirect(user, provider, resolver) Liên kết OAuthProvider với tài khoản người dùng bằng quy trình chuyển hướng toàn trang.
multiFactor(user) MultiFactorUser (Người dùng đa yếu tố) tương ứng với người dùng.
reauthenticateWithCredential(user, credential) Xác thực lại người dùng bằng thông tin xác thực mới.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) Xác thực lại người dùng bằng thông tin đăng nhập điện thoại mới.
reauthenticateWithPopup(user, provider, resolver) Xác thực lại người dùng hiện tại bằng OAuthProvider đã chỉ định thông qua luồng OAuth dựa trên cửa sổ bật lên.
reauthenticateWithRedirect(user, provider, resolver) Xác thực lại người dùng hiện tại bằng OAuthProvider đã chỉ định thông qua 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(user, actionCodeSettings) Gửi email xác minh cho người dùng.
Huỷ liên kết(người dùng, Mã nhà cung cấp) Huỷ liên kết nhà cung cấp khỏi tài khoản người dùng.
updateEmail(user, newEmail) Cập nhật địa chỉ email của người dùng.
updatePassword(user, newPassword) Cập nhật mật khẩu của người dùng.
updatePhoneNumber(user, credential) Cập nhật số điện thoại của người dùng.
updateProfile(user, { displayName, photoURL: photoUrl }) Cập nhật dữ liệu hồ sơ của người dùng.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) Gửi email xác minh đến một địa chỉ email mới.
hàm(userCredential, ...)
getAdditionalUserInfo(userCredential) Trích xuất AdditionalUserInfo cụ thể của nhà cung cấp cho thông tin đăng nhập đã cho.

Lớp

Lớp Nội dung mô tả
ActionCodeURL Một lớp tiện ích để phân tích cú pháp các URL tác vụ email như đặt lại mật khẩu, xác minh email, đăng nhập liên kết email, v.v.
AuthCredential Giao diện đại diện cho thông tin xác thực mà AuthProvider trả về.
EmailAuthCredential Giao diện đại diện cho thông tin đăng nhập mà EmailAuthProvider trả về cho ProviderId.Password
EmailAuthProvider Nhà cung cấp dịch vụ tạo EmailAuthCredential.
FacebookAuthProvider Nhà cung cấp có thể tạo OAuthCredential cho ProviderId.FACEBOOK.
GithubAuthProvider Nhà cung cấp để tạo OAuthCredential cho ProviderId.GITHUB.
GoogleAuthProvider Nhà cung cấp để tạo OAuthCredential cho ProviderId.GOOGLE.
OAuthCredential Biểu thị thông tin đăng nhập OAuth do OAuthProvider trả về.
OAuthProvider Nhà cung cấp để tạo OAuthCredential (Thông tin xác thực OAuth) chung.
PhoneAuthCredential Biểu thị thông tin đăng nhập do PhoneAuthProvider trả về.
PhoneAuthProvider Nhà cung cấp dịch vụ tạo PhoneAuthCredential.
PhoneMultiFactorGenerator Nhà cung cấp dùng để tạo một PhoneMultiFactorAssertion.
RecaptchaVerifier Trình xác minh ứng dụng dựa trên reCAPTCHA.
SAMLAuthProvider AuthProvider cho SAML.
TotpMultiFactorGenerator Nhà cung cấp dùng để tạo một TotpMultiFactorAssertion.
TotpSecret Nhà cung cấp dùng để tạo một TotpMultiFactorAssertion.Lưu trữ khoá 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 thức để truy xuất khoá bí mật dùng chung và tạo URL bằng mã QR.
TwitterAuthProvider Nhà cung cấp để tạo OAuthCredential cho ProviderId.TWITTER.

Giao diện

Giao diện Nội dung mô tả
ActionCodeInfo Phản hồi từ checkActionCode().
ActionCodeSettings Một giao diện xác định URL tiếp tục/trạng thái bắt buộc bằng các giá trị nhận dạng gói Android và iOS (không bắt buộc).
AdditionalUserInfo Một cấu trúc chứa thông tin bổ sung về người dùng từ một nhà cung cấp danh tính được liên kết.
ApplicationVerifier Trình xác minh để xác minh miền và ngăn chặn hành vi sai trái.
Xác thực Giao diện biểu thị dịch vụ Xác thực Firebase.
AuthError Giao diện cho một lỗi Auth.
AuthErrorMap Liên kết các mã lỗi với các thông báo lỗi.
AuthProvider Giao diện đại diện cho trình cung cấp dịch vụ xác thực, dùng để hỗ trợ việc tạo AuthCredential.
AuthSettings Giao diện biểu thị chế độ cài đặt của một thực thể Auth.
Cấu hình Giao diện biểu thị cấu hình Auth.
ConfirmationResult Kết quả từ việc đăng nhập, liên kết hoặc xác thực lại cuộc gọi qua số điện thoại.
Phần phụ thuộc Các phần phụ thuộc có thể dùng để khởi chạy một thực thể Auth.
EmulatorConfig Cấu hình của Trình mô phỏng xác thực Firebase.
IdTokenResult Giao diện biểu thị kết quả mã thông báo mã nhận dạng thu được từ User.getIdTokenResult().
MultiFactorAssertion Lớp cơ sở để xác nhận quyền sở hữu yếu tố thứ hai.
MultiFactorError Lỗi được tạo ra khi người dùng cần cung cấp yếu tố thứ hai để đăng nhập thành công.
MultiFactorInfo Cấu trúc chứa thông tin về thực thể yếu tố thứ hai.
MultiFactorResolver Lớp này dùng để hỗ trợ việc khôi phục từ MultiFactorError khi người dùng cần cung cấp một yếu tố thứ hai để đăng nhập.
MultiFactorSession Giao diện xác định đối tượng phiên đa yếu tố, được dùng để đăng ký yếu tố thứ hai cho người dùng hoặc giúp đăng nhập một người dùng đã đăng ký bằng yếu tố thứ hai.
MultiFactorUser Một giao diện xác định các thuộc tính và hoạt động liên quan đến đa yếu tố liên quan đến Người dùng.
OAuthCredentialOptions Xác định các tuỳ chọn để khởi chạy OAuthCredential.
ParsedToken Giao diện đại diện cho mã thông báo giá trị nhận dạng đã phân tích cú pháp.
PasswordPolicy Cấu trúc chỉ định các yêu cầu của chính sách mật khẩu.
PasswordValidationStatus Một cấu trúc cho biết những yêu cầu trong chính sách về mật khẩu đã đáp ứng hoặc bị vi phạm và những yêu cầu đó là gì.
Khả năng duy trì lâu dài Một giao diện bao gồm các loại cơ chế cố định có thể có.
PhoneMultiFactorAssertion Lớp để xác nhận quyền sở hữu yếu tố thứ hai của điện thoại. Do PhoneMultiFactorGenerator.assertion() cung cấp.
PhoneMultiFactorEnrollInfoOptions Các tuỳ chọn dùng để đăng ký yếu tố thứ hai.
PhoneMultiFactorInfo Lớp con của giao diện MultiFactorInfo cho yếu tố thứ hai của số điện thoại. factorId của yếu tố thứ hai này là FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions Các tuỳ chọn dùng để đăng nhập có yếu tố thứ hai.
PhoneSingleFactorInfoOptions Các tuỳ chọn dùng để đăng nhập bằng một yếu tố.
PopupRedirectResolver Trình phân giải được dùng để xử lý các thao tác cụ thể của DOM như signInWithPopup() hoặc signInWithRedirect().
ReactNativeAsyncStorage Giao diện cho AsyncStorage đã cung cấp.
RecaptchaParameters Giao diện biểu thị các tham số của reCAPTCHA.Xem [tài liệu về reCAPTCHA](https://developers.google.com/recaptcha/docs/display#soạn_param) để biết danh sách các tham số được chấp nhận. Tất cả tham số đều được chấp nhận ngoại trừ sitekey: Dịch vụ Xác thực Firebase cấp một reCAPTCHA cho mỗi dự án và sẽ định cấu hình khoá trang web khi hiển thị.Đối với reCAPTCHA ẩn, hãy đặt khoá size thành invisible.
TotpMultiFactorAssertion Lớp để xác nhận quyền sở hữu yếu tố thứ hai TOTP. Do TotpMultiFactorGenerator.assertionForEnrollment()TotpMultiFactorGenerator.assertionForSignIn() cung cấp.
TotpMultiFactorInfo 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.
User Tài khoản người dùng.
UserCredential Cấu trúc chứa User (Người dùng), OperationType (Loại hoạt động) và mã nhà cung cấp.
UserInfo Thông tin hồ sơ người dùng, chỉ hiển thị cho các ứng dụng của dự án Firebase.
UserMetadata Giao diện biểu thị siêu dữ liệu của người dùng.

Biến

Biến Nội dung mô tả
ActionCodeOperation Bảng liệt kê các loại tác vụ email có thể thực hiện.
AuthErrorCodes Sơ đồ các mã lỗi Auth tiềm ẩn để dễ dàng so sánh với các lỗi do SDK gửi.
browserLocalPersistence Triển khai thuộc tính Persistence thuộc loại LOCAL bằng localStorage cho bộ nhớ cơ bản.
browserPopupRedirectResolver Cách triển khai PopupRedirectResolver phù hợp với các ứng dụng dựa trên trình duyệt.
browserSessionPersistence Triển khai tính năng Persistence của SESSION bằng sessionStorage cho bộ nhớ cơ bản.
cordovaPopupRedirectResolver Triển khai PopupRedirectResolver phù hợp với các ứng dụng dựa trên biến
debugErrorMap 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
FactorId Danh sách các yếu tố có thể dùng để xác thực đa yếu tố.
indexedDBLocalPersistence Triển khai thuộc tính Persistence thuộc loại LOCAL bằng indexedDB cho bộ nhớ cơ bản.
inMemoryPersistence Triển khai Persistence thuộc loại "NONE".
OperationType Liệt kê các loại thao tác được hỗ trợ.
prodErrorMap Sơ đồ lỗi tối thiểu và loại bỏ tất cả các thông báo lỗi chi tiết.Xem nội dung thảo luận tại AuthErrorMap
ProviderId Bảng liệt kê các nhà cung cấp được hỗ trợ.
SignInMethod Liệt kê các phương thức đăng nhập được hỗ trợ.

Loại bí danh

Loại bí danh Nội dung mô tả
CustomParameters Bản đồ thông số tùy chỉnh OAuth.
NextOrObserver Định nghĩa loại cho lệnh gọi lại sự kiện.
PhoneInfoOptions Thông tin cần thiết để xác minh quyền sở hữu một số điện thoại.
UserProfile Hồ sơ người dùng được sử dụng trong AdditionalUserInfo.

chức năng(ứng dụng, ...)

getAuth(app)

Trả về thực thể Xác thực được liên kết với FirebaseApp đã cung cấp. Nếu không có thực thể nào tồn tại, hãy khởi chạy một thực thể 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;

Tham số

Thông số Loại Nội dung mô tả
ứng dụng FirebaseApp Ứng dụng Firebase.

Trường hợp trả lại hàng:

Xác thực

initializeAuth(app, deps)

Khởi động một thực thể Auth với quyền kiểm soát chi tiết đối với Phần phụ thuộc.

Hàm này cho phép kiểm soát thực thể Auth nhiều hơn so với getAuth(). getAuth sử dụng 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 chạy Xác thực và phù hợp với 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 cố định nào được sử dụng, hoặc để giảm thiểu kích thước gói nếu bạn hiệ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 các tài khoản cho phiên hiện tại, hãy khởi chạy Auth bằng:

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

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
ứng dụng FirebaseApp
Phần phụ thuộc Phần phụ thuộc

Trường hợp trả lại hàng:

Xác thực

hàm(bộ nhớ, ...)

getReactNativePersistence(storage)

Trả về một đối tượng cố định bao bọc AsyncStorage được nhập từ react-native hoặc @react-native-community/async-storage. Đối tượng này có thể dùng trong trường phần phụ thuộc cố định trong initializeAuth().

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
lượng nước giữ lại ReactNativeAsyncStorage

Trường hợp trả lại hàng:

Khả năng duy trì lâu dài

hàm(xác thực, ...)

applyActionCode(auth, oobCode)

Áp dụng mã xác minh 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 applyActionCode(auth: Auth, oobCode: string): Promise<void>;

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
oobCode string Mã xác minh đã được gửi cho người dùng.

Trường hợp trả lại hàng:

Promise<void>

beforeAuthStateChanged(auth, callback, 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;

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
số gọi lại (user: User | null) => void | Promise<void> lệnh gọi lại được kích hoạt trước khi đặt giá trị người dùng mới. Nếu hộp thoại này gửi, nó sẽ không cho phép thiết lập người dùng.
onAbort () => trống lệnh gọi lại được kích hoạt nếu lệnh gọi lại beforeAuthStateChanged() sau đó gửi ra, cho phép bạn huỷ mọi tác dụng phụ.

Trường hợp trả lại hàng:

Huỷ đăng ký

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>;

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
oobCode string Mã xác minh đã được gửi cho người dùng.

Trường hợp trả lại hàng:

Promise<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>;

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
oobCode string Mã xác nhận đã được gửi cho người dùng.
newPassword string Mật khẩu mới.

Trường hợp trả lại hàng:

Promise<void>

connectAuthEmulator(auth, url, options)

Thay đổi thực thể Auth để giao tiếp với Trình mô phỏng xác thực Firebase, thay vì các dịch vụ Xác thực Firebase chính thức.

Lệnh này phải được gọi đồng bộ ngay sau lệnh gọi đầu tiên đến initializeAuth(). Không sử dụng cùng với thông tin đăng nhập cho phiên bản chính thức vì lưu lượng truy cập của trình mô phỏng không được mã hoá.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
url string URL mà trình mô phỏng đang chạy (ví dụ: "http://localhost:9099").
tùy chọn { disableWarnings: boolean; } Không bắt buộc. options.disableWarnings mặc định là false. Đặt thuộc tính này thành true để vô hiệu hoá biểu ngữ cảnh báo đính kèm vào DOM.

Trường hợp trả lại hàng:

void

Ví dụ:

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

createUserWithEmailAndPassword(auth, email, password)

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 đã chỉ định.

Khi tạo tài khoản người dùng thành công, người dùng này cũng sẽ được đăng nhập vào ứng dụng của bạn.

Không tạo được tài khoản người dùng nếu tài khoản đã tồn tại hoặc mật khẩu không hợp lệ.

Phương thức này không được hỗ trợ trên các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
email string Địa chỉ email của người dùng.
mật khẩu string Mật khẩu do người dùng chọn.

Trường hợp trả lại hàng:

Promise<UserCredential>

fetchSignInMethodsForEmail(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 [Tính năng bảo vệ danh sách 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 rất hữu ích khi phân biệt các phương thức đăng nhập của cùng một nhà cung cấp, ví dụ: EmailAuthProvider có 2 phương thức đăng nhập là SignInMethod.EMAIL_passwords và SignInMethod.EMAIL_LINK.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
email string Địa chỉ email của người dùng.Không dùng nữa. Bạn nên di chuyển khỏi phương thức này vì đây là một phương pháp bảo mật hay nhất. Tìm hiểu thêm trong tài liệu về Nền tảng nhận dạng cho [Biện pháp bảo vệ danh tính email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

Trường hợp trả lại hàng:

Hứa hẹn<string[]>

getMultiFactorResolver(auth, error)

Cung cấp một MultiFactorResolver phù hợp để hoàn tất quy trình đa yếu tố.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
error MultiFactorError MultiFactorError (Lỗi đa yếu tố) xuất hiện trong hoạt động đăng nhập hoặc xác thực lại.

Trường hợp trả lại hàng:

MultiFactorResolver

getRedirectResult(auth, resolver)

Trả về UserCredential trong quy trình đăng nhập dựa trên lệnh chuyển hướng.

Nếu đăng nhập thành công, hệ thống sẽ trả về người dùng đã đăng nhập. Nếu đăng nhập không thành công thì sẽ xảy ra lỗi. Nếu không có hoạt động chuyển hướng nào được gọi, hàm sẽ trả về null.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
trình phân giải PopupRedirectResolver Một thực thể của PopupRedirectResolver, không bắt buộc nếu đã được cung cấp cho initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Promise<UserCredential | null>

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;

initializeRecaptchaConfig(auth)

Tải cấu hình reCAPTCHA vào thực thể Auth.

Thao tác này sẽ tải cấu hình reCAPTCHA, cho biết liệu có cần kích hoạt luồng xác minh reCAPTCHA cho mỗi nhà cung cấp dịch vụ xác thực vào phiên Xác thực hiện tại hay không.

Nếu khởi tạoRecaptchaConfig() không được gọi, thì quy trình xác thực sẽ luôn bắt đầu mà không cần xác minh reCAPTCHA. Nếu trình cung cấp được định cấu hình để yêu cầu xác minh bằng reCAPTCHA, thì SDK sẽ tải cấu hình reCAPTCHA một cách minh bạch và khởi động lại quy trình xác thực.

Do đó, bằng cách gọi phương thức không bắt buộc này, bạn sẽ giảm được độ trễ của các quy trình xác thực trong tương lai. Việc tải cấu hình reCAPTCHA sớm cũng sẽ cải thiện tín hiệu do reCAPTCHA thu thập.

Phương thức này không hoạt động trong môi trường Node.js.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.

Trường hợp trả lại hàng:

Promise<void>

Ví dụ:

initializeRecaptchaConfig(auth);

Kiểm tra xem đường liên kết đến có phải là đường liên kết đăng nhập bằng đường liên kết email phù hợp với signInWithEmailLink() hay không.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
emailLink string Đường liên kết được gửi đến địa chỉ email của người dùng.

Trường hợp trả lại hàng:

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

Thêm trình quan sát đối với các thay đổi đối với trạng thái đăng nhập của người dùng.

Để giữ lại hành vi cũ, hãy xem onIdTokenChanged().

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
nextOrObserver NextOrObserver<Người dùng> lệnh gọi lại được kích hoạt khi thay đổi.
error ErrorFn Không dùng nữa. Lệnh 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ể mắc phải trong những lời hứa trả về từ các hàm đăng nhập/đăng xuất.
đã hoàn tất CompleteFn Không dùng nữa. Lệnh gọi lại này không bao giờ được kích hoạt.

Trường hợp trả lại hàng:

Huỷ đăng ký

onIdTokenChanged(auth, nextOrObserver, error, completed)

Thêm trình quan sát đối với các thay đổi đối với mã thông báo mã nhận dạng 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. Hành động này sẽ không được tự động kích hoạt khi mã thông báo giá trị nhận dạng hết hạn. Sử dụng User.getIdToken() để làm mới mã thông báo mã nhận dạng.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
nextOrObserver NextOrObserver<Người dùng> lệnh gọi lại được kích hoạt khi thay đổi.
error ErrorFn Không dùng nữa. Lệnh 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ể mắc phải trong những lời hứa trả về từ các hàm đăng nhập/đăng xuất.
đã hoàn tất CompleteFn Không dùng nữa. Lệnh gọi lại này không bao giờ được kích hoạt.

Trường hợp trả lại hàng:

Huỷ đăng ký

revokeAccessToken(auth, token)

Thu hồi mã truy cập đã cấp. Hiện chỉ hỗ trợ mã truy cập OAuth của Apple.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
mã thông báo string Mã truy cập OAuth của Apple.

Trường hợp trả lại hàng:

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Gửi email đặt lại mật khẩu đến địa chỉ email đã chỉ định. Phương thức 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à tính năng [Bảo vệ tính năng liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật.

Để hoàn tất quá trình đặt lại mật khẩu, hãy gọi confirmPasswordReset() bằng mã được cung cấp trong email được 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>;

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
email string Địa chỉ email của người dùng.
actionCodeSettings ActionCodeSettings ActionCodeSettings.

Trường hợp trả lại hàng:

Promise<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 đường liên kết email đăng nhập cho người dùng bằng email được chỉ định.

Hoạt động đăng nhập phải luôn hoàn tất trong ứng dụng, khác với các thao tác khác đối với email bên ngoài nhóm (đặt lại mật khẩu và xác minh email). Điều này là do vào cuối quy trình, người dùng cần phải đă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 việc đăng nhập bằng đường liên kết email, hãy gọi hàm signInWithEmailLink() bằng địa chỉ email và đường 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>;

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực
email string Địa chỉ email của người dùng.
actionCodeSettings ActionCodeSettings ActionCodeSettings.

Trường hợp trả lại hàng:

Promise<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, persistence)

Thay đổi kiểu lưu trữ cố định trên thực thể Auth (Xác thực) cho phiên Auth hiện đã lưu và áp dụng kiểu lưu trữ này cho các yêu cầu đăng nhập sau này, bao gồm cả hoạt động đăng nhập bằng yêu cầu chuyển hướng.

Tính năng này giúp người dùng đăng nhập dễ dàng chỉ định xem có nên ghi nhớ phiên của mình hay không. Điều này cũng giúp bạn dễ dàng không bao giờ duy trì trạng thái Auth cho những ứng dụng do người dùng khác chia sẻ hoặc có dữ liệu nhạy cảm.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
bền bỉ Khả năng duy trì lâu dài Giá trị cố định (Persistence) để sử dụng.

Trường hợp trả lại hàng:

Promise<void>

Một Promise được phân giải sau khi kết thúc thay đổi về dữ liệu cố định

Ví dụ:

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

Đăng nhập không đồng bộ với tư cách người dùng ẩn danh.

Nếu đã có một 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ề.

Các thực thể Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.

Trường hợp trả lại hàng:

Promise<UserCredential>

signInWithCredential(auth, credential)

Đăng nhập không đồng bộ bằng thông tin đăng nhập đã cho.

Bạn có thể sử dụng AuthProvider để tạo thông tin xác thực.

Các thực thể Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
thông tin xác thực AuthCredential Thông tin xác thực.

Trường hợp trả lại hàng:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

Đăng nhập không đồng bộ bằng mã thông báo tuỳ chỉnh.

Mã thông báo tuỳ chỉnh được dùng để tích hợp tính năng Xác thực Firebase với các hệ thống xác thực hiện có. Các mã thông báo này phải được tạo bằng chương trình phụ trợ xác thực bằng phương thức createCustomToken trong SDK quản trị.

Xảy ra lỗi nếu mã thông báo không hợp lệ, đã hết hạn hoặc không được dịch vụ Xác thực Firebase chấp nhận.

Các thực thể Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
customToken string Mã thông báo tuỳ chỉnh để đăng nhập.

Trường hợp trả lại hàng:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

Đăng nhập không đồng bộ bằng email và mật khẩu.

Lỗi với lỗi nếu địa chỉ email và mật khẩu không khớp. Khi bạn bật tính năng [Bảo vệ liệt kê email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) thì phương thức này sẽ không thành công với "auth/auth-credential" trong trường hợp email/mật khẩu không hợp lệ.

Phương thức này không được hỗ trợ trên các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
email string Địa chỉ email của người dùng.
mật khẩu string Mật khẩu của người dùng.

Trường hợp trả lại hàng:

Promise<UserCredential>

Đăng nhập không đồng bộ bằng email và đường liên kết đăng nhập qua email.

Nếu không có đường liên kết nào đi qua, thì đường liên kết này sẽ được suy ra từ URL hiện tại.

Lỗi sẽ xuất hiện nếu địa chỉ email không hợp lệ hoặc OTP trong đường liên kết trong email hết hạn.

Các thực thể Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
email string Địa chỉ email của người dùng.
emailLink string Đường liên kết được gửi đến địa chỉ email của người dùng.

Trường hợp trả lại hàng:

Promise<UserCredential>

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 số điện thoại.

Phương thức này gửi một mã qua SMS đến số điện thoại đã cho và trả về ConfirmationResult. Sau khi người dùng cung cấp mã được gửi đến đ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 hành vi sai trái, phương thức này cũng yêu cầu bạn phải có một ApplicationVerifier. SDK này bao gồm một phương thức triển khai dựa trên reCAPTCHA, RecaptchaVerifier. Hàm 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 phương thức triển khai ApplicationVerifier của bên thứ ba.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
phoneNumber string Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

Trường hợp trả lại hàng:

Promise<ConfirmationResult>

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, provider, resolver)

Xác thực ứng dụng Firebase bằng quy trình xác thực OAuth dựa trên cửa sổ bật lên.

Nếu thành công, hãy trả về người dùng đã đăng nhập cùng với thông tin đăng nhập của nhà cung cấp. Nếu đăng nhập không thành công, hàm sẽ trả về một đối tượng lỗi chứa thông tin bổ sung về lỗi đó.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
provider AuthProvider Nhà cung cấp sẽ 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.
trình phân giải PopupRedirectResolver Một thực thể của PopupRedirectResolver, không bắt buộc nếu đã được cung cấp cho initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Promise<UserCredential>

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, provider, resolver)

Xác thực ứng dụng Firebase bằng quy trình chuyển hướng toàn trang.

Để xử lý kết quả và lỗi cho thao tác này, hãy tham khảo getRedirectResult(). Hãy làm theo các phương pháp hay nhất khi sử dụng signInWithRedirect().

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
provider AuthProvider Nhà cung cấp sẽ 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.
trình phân giải PopupRedirectResolver Một thực thể của PopupRedirectResolver, không bắt buộc nếu đã được cung cấp cho initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Hứa hẹn<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.

Các thực thể Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.

Trường hợp trả lại hàng:

Promise<void>

updateCurrentUser(auth, user)

Đặt người dùng được cung cấp là Auth.currentUser một cách không đồng bộ trên thực thể Auth.

Một bản sao mới của người dùng đã cung cấp sẽ được tạo và đặt làm currentUser.

Thao tác này sẽ kích hoạt trình nghe onAuthStateChanged()onIdTokenChanged() như các phương thức đăng nhập khác.

Thao tác sẽ không thực hiện được và sẽ xảy ra lỗi nếu người dùng được cập nhật thuộc về một dự án Firebase khác.

Các thực thể Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
người dùng Người dùng | rỗng Người dùng mới .

Trường hợp trả lại hàng:

Promise<void>

useDeviceLanguage(auth)

Đặt ngôn ngữ hiện tại thành tuỳ chọn thiết bị/trình duyệt mặc định.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.

Trường hợp trả lại hàng:

void

validatePassword(auth, password)

Xác thực mật khẩu dựa trên 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 bạn không đặt mã nhận dạng người thuê trong thực thể 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 thức này sẽ sử dụng chính sách được thiết lập cho đối tượng thuê. Nếu bạn chưa định cấu hình chính sách mật khẩu, thì hệ thống sẽ sử dụng chính sách mặc định được định cấu hình cho tất cả dự án.

Nếu quy trình 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 của 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 mới nhất hiện có khi được gọi lại.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
mật khẩu string Mật khẩu cần xác thực.

Trường hợp trả lại hàng:

Promise<PasswordValidationStatus>

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>;

Tham số

Thông số Loại Nội dung mô tả
xác thực Xác thực Thực thể Auth.
string Mã xác minh đã được gửi cho người dùng.

Trường hợp trả lại hàng:

Hứa hẹn<string>

địa chỉ email của người dùng nếu hợp lệ.

parseActionCodeURL(đường liên kết)

Phân tích cú pháp chuỗi liên kết thao tác gửi email và trả về ActionCodeURL nếu đường liên kết hợp lệ, nếu không thì sẽ trả về giá trị rỗng.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
đường liên kết string

Trường hợp trả lại hàng:

ActionCodeURL | rỗng

chức năng(người dùng, ...)

deleteUser(user)

Xoá và đăng xuất người dùng.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.

Trường hợp trả lại hàng:

Promise<void>

getIdToken(user, forceRefresh)

Trả về một mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho một dịch vụ Firebase.

Trả về mã thông báo hiện tại nếu mã chưa hết hạn hoặc chưa hết hạn sau 5 phút nữa. Nếu không, mã thông báo sẽ được làm mới và trả về một mã mới.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
forceRefresh boolean Buộc làm mới bất kể thời hạn của mã thông báo.

Trường hợp trả lại hàng:

Hứa hẹn<string>

getIdTokenResult(user, forceRefresh)

Trả về mã thông báo web JSON đã giải tuần tự (JWT) được dùng để xác định người dùng cho một dịch vụ Firebase.

Trả về mã thông báo hiện tại nếu mã chưa hết hạn hoặc chưa hết hạn sau 5 phút nữa. Nếu không, mã thông báo sẽ được làm mới và trả về một mã mới.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
forceRefresh boolean Buộc làm mới bất kể thời hạn của mã thông báo.

Trường hợp trả lại hàng:

Promise<IdTokenResult>

linkWithCredential(user, credential)

Liên kết tài khoản người dùng với thông tin đăng nhập đã cho.

Bạn 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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
thông tin xác thực AuthCredential Thông tin xác thực.

Trường hợp trả lại hàng:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

Liên kết tài khoản người dùng với số điện thoại đã cho.

Phương thức 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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
phoneNumber string Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

Trường hợp trả lại hàng:

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

Liên kết trình cung cấp đã xác thực với tài khoản người dùng bằng quy trình 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 thức 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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
provider AuthProvider Nhà cung cấp sẽ 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.
trình phân giải PopupRedirectResolver Một thực thể của PopupRedirectResolver, không bắt buộc nếu đã được cung cấp cho initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Promise<UserCredential>

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(user, provider, resolver)

Liên kết OAuthProvider với tài khoản người dùng bằng quy trình chuyển hướng toàn trang.

Để xử lý kết quả và lỗi cho thao tác này, hãy tham khảo getRedirectResult(). Làm theo các phương pháp hay nhất khi sử dụng linkWithRedirect().

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
provider AuthProvider Nhà cung cấp sẽ 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.
trình phân giải PopupRedirectResolver Một thực thể của PopupRedirectResolver, không bắt buộc nếu đã được cung cấp cho initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Hứa hẹn<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);

multiFactor(user)

MultiFactorUser (Người dùng đa yếu tố) tương ứng với người dùng.

Thuộc tính này dùng để truy cập vào tất cả các thuộc tính và thao tác đa yếu tố liên quan đến người dùng.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.

Trường hợp trả lại hàng:

MultiFactorUser

reauthenticateWithCredential(user, credential)

Xác thực lại người dùng bằng thông tin xác thực mới.

Dùng trước các thao tác như updatePassword() yêu cầu mã thông báo từ các lần đăng nhập gần đây. Bạn có thể sử dụng phương thức này để khôi phục lỗi CREDENTIAL_TOO_OLD_LOGIN_AGAIN hoặc lỗi TOKEN_EXPIRED.

Phương thức này không được hỗ trợ trên mọi Người dùng đăng nhập bằng thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
thông tin xác thực AuthCredential Thông tin xác thực.

Trường hợp trả lại hàng:

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

Xác thực lại người dùng bằng thông tin đăng nhập điện thoại mới.

Dùng trước các thao tác như updatePassword() yêu cầu mã thông báo từ các lần đăng nhập gần đây.

Phương thức này không hoạt động trong môi trường Node.js hoặc trên bất kỳ Người dùng nào đăng nhập bằng thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
phoneNumber string Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

Trường hợp trả lại hàng:

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

Xác thực lại người dùng hiện tại bằng OAuthProvider đã chỉ định thông qua 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, thì 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 thức này không hoạt động trong môi trường Node.js hoặc trên bất kỳ Người dùng nào đăng nhập bằng thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
provider AuthProvider Nhà cung cấp sẽ 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.
trình phân giải PopupRedirectResolver Một thực thể của PopupRedirectResolver, không bắt buộc nếu đã được cung cấp cho initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Promise<UserCredential>

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);

reauthenticateWithRedirect(user, provider, resolver)

Xác thực lại người dùng hiện tại bằng OAuthProvider đã chỉ định thông qua 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(). Làm theo các phương pháp hay nhất khi sử dụng reauthenticateWithRedirect().

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
provider AuthProvider Nhà cung cấp sẽ 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.
trình phân giải PopupRedirectResolver Một thực thể của PopupRedirectResolver, không bắt buộc nếu đã được cung cấp cho initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Hứa hẹn<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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.

Trường hợp trả lại hàng:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

Gửi email xác minh cho người dùng.

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 sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
actionCodeSettings ActionCodeSettings | rỗng ActionCodeSettings.

Trường hợp trả lại hàng:

Promise<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);

Huỷ 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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
providerId string Nhà cung cấp mà bạn muốn huỷ liên kết.

Trường hợp trả lại hàng:

Hứa hẹn<Người dùng>

updateEmail(user, newEmail)

Cập nhật địa chỉ email của người dùng.

Email sẽ được gửi đến địa chỉ email ban đầu (nếu đã được thiết lập). Email này cho phép thu hồi sự thay đổi địa chỉ email để bảo vệ họ khỏi hành vi chiếm đoạt tài khoản.

Phương thức này không được hỗ trợ trên mọi Người dùng đăng nhập bằng thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
newEmail string Địa chỉ email mới.Gửi lỗi "auth/operation-not-allowed" khi [Tính năng bảo vệ danh sách email](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) được bật. Không dùng nữa – Thay vào đó, hãy sử dụng verifyBeforeUpdateEmail().

Trường hợp trả lại hàng:

Promise<void>

updatePassword(user, 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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
newPassword string Mật khẩu mới.

Trường hợp trả lại hàng:

Promise<void>

updatePhoneNumber(user, credential)

Cập nhật số điện thoại của người dùng.

Phương thức này không hoạt động trong môi trường Node.js hoặc trên bất kỳ Người dùng nào đăng nhập bằng thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
thông tin xác thực PhoneAuthCredential Thông tin xác thực số điện thoại mới.

Trường hợp trả lại hàng:

Promise<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(user, { 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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
{ displayName, photoURL: photoUrl } { displayName?: string | null; photoURL?: string | null; }

Trường hợp trả lại hàng:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

Gửi email xác minh đến một địa chỉ email mới.

Email của người dùng sẽ được cập nhật thành địa chỉ email mới sau khi được xác minh.

Nếu có một trình xử lý thao tác đối với email tuỳ 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>;

Tham số

Thông số Loại Nội dung mô tả
người dùng User Người dùng.
newEmail string Địa chỉ email mới cần được xác minh trước khi cập nhật.
actionCodeSettings ActionCodeSettings | rỗng ActionCodeSettings.

Trường hợp trả lại hàng:

Promise<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);

hàm(userCredential, ...)

getAdditionalUserInfo(userCredential)

Trích xuất AdditionalUserInfo cụ thể của nhà cung cấp cho thông tin đăng nhập đã cho.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
userCredential UserCredential Thông tin đăng nhập của người dùng.

Trường hợp trả lại hàng:

AdditionalUserInfo | rỗng

ActionCodeOperation

Bảng liệt kê các loại tác vụ email có thể thực hiện.

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";
}

AuthErrorCodes

Sơ đồ các mã lỗi Auth tiềm ẩn để dễ dàng so sánh với các lỗi do SDK gửi.

Lưu ý rằng bạn không thể lắc cây các khoá riêng lẻ trong 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";
}

browserLocalPersistence

Triển khai thuộc tính Persistence thuộc loại LOCAL bằng localStorage cho bộ nhớ cơ bản.

Chữ ký:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

Cách triển khai PopupRedirectResolver phù hợp với các ứng dụng dựa trên trình duyệt.

Phương thức này không hoạt động trong môi trường Node.js.

Chữ ký:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

Triển khai tính năng Persistence của SESSION bằng sessionStorage cho bộ nhớ cơ bản.

Chữ ký:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

Triển khai PopupRedirectResolver phù hợp với các ứng dụng dựa trên biến

Chữ ký:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

Một bản đồ lỗi chi tiết với nội dung mô tả chi tiết về hầu hết các mã lỗi.

Xem cuộc thảo luận tại AuthErrorMap

Chữ ký:

debugErrorMap: AuthErrorMap

FactorId

Danh sách các yếu tố có thể dùng để xác thực đa yếu tố.

Chữ ký:

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

indexedDBLocalPersistence

Triển khai thuộc tính Persistence thuộc loại LOCAL bằng indexedDB cho bộ nhớ cơ bản.

Chữ ký:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

Triển khai Persistence thuộc loại "NONE".

Chữ ký:

inMemoryPersistence: Persistence

OperationType

Liệt kê các loại thao tác được hỗ trợ.

Chữ ký:

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

prodErrorMap

Sơ đồ lỗi tối thiểu, trong đó tất cả thông báo lỗi chi tiết đều bị xoá.

Xem cuộc thảo luận tại AuthErrorMap

Chữ ký:

prodErrorMap: AuthErrorMap

ProviderId

Bảng liệt kê 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";
}

SignInMethod

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";
}

CustomParameters

Bản đồ thông số tùy chỉnh OAuth.

Chữ ký:

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

NextOrObserver

Định nghĩa loại cho lệnh gọi lại sự kiện.

Chữ ký:

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

PhoneInfoOptions

Thông tin cần thiết để xác minh quyền sở hữu một số điện thoại.

Thông tin bắt buộc sẽ tuỳ thuộc vào việc bạn đang đăng nhập bằng một yếu tố, đăng ký đa yếu tố hay đăng nhập đa yếu tố.

Chữ ký:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

Hồ sơ người dùng được sử dụng trong AdditionalUserInfo.

Chữ ký:

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