Giao diện mẹ chung cho cả API Auth và TenantAwareAuth.
Chữ ký:
export declare abstract class BaseAuth
Phương thức
| Phương thức | Đối tượng sửa đổi | Mô tả |
|---|---|---|
| createCustomToken(uid, developerClaims) | Tạo một mã thông báo tuỳ chỉnh (JWT) mới của Firebase. Mã này có thể được gửi lại thiết bị khách để sử dụng cho việc đăng nhập bằng phương thức signInWithCustomToken() của SDK ứng dụng. (Các thực thể nhận biết được người thuê cũng sẽ nhúng mã người thuê vào mã thông báo.)Hãy xem bài viết Tạo mã thông báo tuỳ chỉnh để xem các mã mẫu và tài liệu chi tiết. |
|
| createProviderConfig(config) | Trả về một lời hứa sẽ giải quyết bằng AuthProviderConfig mới tạo khi cấu hình nhà cung cấp mới được tạo.Dịch vụ hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP. |
|
| createSessionCookie(idToken, sessionCookieOptions) | Tạo cookie phiên mới trên Firebase có các lựa chọn được chỉ định. Bạn có thể đặt chuỗi JWT đã tạo làm cookie phiên phía máy chủ với chính sách cookie tuỳ chỉnh và dùng để quản lý phiên. Cookie phiên JWT sẽ có cùng các xác nhận quyền sở hữu tải trọng như mã thông báo ID được cung cấp.Xem Quản lý cookie phiên để biết mã mẫu và tài liệu chi tiết. | |
| createUser(thuộc tính) | Tạo một người dùng mới.Xem bài viết Tạo người dùng để xem mã mẫu và tài liệu chi tiết. | |
| deleteProviderConfig(providerId) | Xoá cấu hình của nhà cung cấp tương ứng với mã nhà cung cấp đã chuyển. Nếu mã được chỉ định không tồn tại, lỗi auth/configuration-not-found sẽ được gửi đi.Dịch vụ hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP. |
|
| deleteUser(uid) | Xoá một người dùng hiện có.Xem bài viết Xoá người dùng để xem các mã mẫu và tài liệu chi tiết. | |
| deleteUsers(uids) | Xoá người dùng do các uid nhất định chỉ định.Việc xoá người dùng không tồn tại sẽ không tạo ra lỗi (tức là phương thức này không thay đổi). Người dùng không tồn tại được coi là đã xoá thành công, nên sẽ được tính vào giá trị DeleteUsersResult.successCount.Bạn chỉ được cung cấp tối đa 1.000 giá trị nhận dạng. Nếu bạn cung cấp hơn 1.000 giá trị nhận dạng, phương thức này sẽ gửi ra lỗi FirebaseAuthError.API này hiện bị giới hạn tốc độ ở máy chủ ở mức 1 QPS. Nếu vượt quá hạn mức này, bạn có thể gặp lỗi vượt quá hạn mức. Do đó, nếu muốn xoá hơn 1.000 người dùng, bạn có thể cần thêm độ trễ để đảm bảo bạn không vượt quá giới hạn này. |
|
| generateEmailVerifyLink(email, actionCodeSettings) | Tạo đường liên kết đến thao tác bên ngoài email để xác minh quyền sở hữu của người dùng đối với email đã chỉ định. Đối tượng ActionCodeSettings được cung cấp dưới dạng một đối số cho phương thức này xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý cùng với thông tin bổ sung về trạng thái sẽ được truyền trong đường liên kết sâu hay không, v.v. | |
| generatePasswordResetLink(email, actionCodeSettings) | Tạo đường liên kết đến thao tác bên ngoài email để đặt lại mật khẩu của người dùng. Đường liên kết sẽ được tạo cho người dùng có địa chỉ email đã chỉ định. Đối tượng ActionCodeSettings không bắt buộc xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý hay không và thông tin bổ sung về trạng thái sẽ được truyền vào đường liên kết sâu, v.v. | |
| generateSignInWithEmailLink(email, actionCodeSettings) | Tạo đường liên kết đến thao tác bên ngoài email để xác minh quyền sở hữu của người dùng đối với email đã chỉ định. Đối tượng ActionCodeSettings được cung cấp dưới dạng một đối số cho phương thức này xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý cùng với thông tin bổ sung về trạng thái sẽ được truyền trong đường liên kết sâu hay không, v.v. | |
| generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) | Tạo một đường liên kết đến hành động liên quan đến email ngoài phạm vi để xác minh quyền sở hữu của người dùng đối với email đã chỉ định. Đối tượng ActionCodeSettings được cung cấp dưới dạng một đối số cho phương thức này xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý cùng với thông tin bổ sung về trạng thái sẽ được truyền trong đường liên kết sâu hay không, v.v. | |
| getProviderConfig(providerId) | Tra cứu cấu hình của nhà cung cấp dịch vụ xác thực theo mã nhận dạng được cung cấp. Trả về một lời hứa sẽ giải quyết bằng cấu hình nhà cung cấp tương ứng với mã nhà cung cấp đã chỉ định. Nếu mã được chỉ định không tồn tại, lỗi auth/configuration-not-found sẽ được gửi đi.Dịch vụ hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP. |
|
| getUser(uid) | Lấy dữ liệu người dùng của người dùng tương ứng với một uid nhất định.Xem bài viết Truy xuất dữ liệu người dùng để xem mã mẫu và tài liệu chi tiết. |
|
| getUserByEmail(email) | Lấy dữ liệu người dùng của người dùng tương ứng với một email nhất định.Xem bài viết Truy xuất dữ liệu người dùng để xem mã mẫu và tài liệu chi tiết. | |
| getUserByPhoneNumber(phoneNumber) | Lấy dữ liệu người dùng tương ứng với một số điện thoại nhất định. Số điện thoại phải tuân thủ thông số kỹ thuật E.164.Xem bài viết Truy xuất dữ liệu người dùng để xem mã mẫu và tài liệu chi tiết. | |
| getUserByProviderUid(providerId, uid) | Lấy dữ liệu người dùng của người dùng tương ứng với một mã nhà cung cấp nhất định.Xem bài viết Truy xuất dữ liệu người dùng để xem mã mẫu và tài liệu chi tiết. | |
| getUsers(giá trị nhận dạng) | Lấy dữ liệu người dùng tương ứng với các giá trị nhận dạng được chỉ định.Không có đảm bảo về thứ tự; cụ thể, mục nhập thứ n trong danh sách kết quả không đảm bảo sẽ tương ứng với mục nhập thứ n trong danh sách tham số đầu vào.Bạn chỉ được cung cấp tối đa 100 giá trị nhận dạng. Nếu bạn cung cấp hơn 100 giá trị nhận dạng, thì phương thức này sẽ gửi ra lỗi FirebaseAuthError. | |
| importUsers(người dùng, tuỳ chọn) | Nhập danh sách người dùng được cung cấp vào Firebase Auth. Bạn chỉ được phép nhập tối đa 1.000 người dùng cùng một lúc. Khi nhập người dùng bằng mật khẩu, bạn phải chỉ định UserImportOptions. Thao tác này được tối ưu hoá cho tính năng nhập hàng loạt và sẽ bỏ qua các bước kiểm tra trên uid, email cũng như các giá trị nhận dạng duy nhất khác có thể dẫn đến trùng lặp. |
|
| listProviderConfigs(options) | Trả về danh sách cấu hình nhà cung cấp hiện có khớp với bộ lọc đã cung cấp. Bạn chỉ có thể liệt kê tối đa 100 cấu hình của nhà cung cấp cùng một lúc.Để hỗ trợ nhà cung cấp SAML và OIDC, bạn cần có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP. | |
| listUsers(maxResults, pageToken) | Truy xuất danh sách người dùng (chỉ một lô) có kích thước maxResults bắt đầu từ độ lệch do pageToken chỉ định. Tệp này dùng để truy xuất tất cả người dùng của một dự án được chỉ định theo lô.Hãy xem bài viết Liệt kê tất cả người dùng để xem mã mẫu và tài liệu chi tiết. |
|
| revokeRefreshTokens(uid) | Thu hồi tất cả mã thông báo làm mới của một người dùng hiện có.API này sẽ cập nhật UserRecord.tokensValidAfterTime của người dùng thành giờ UTC hiện tại. Điều quan trọng là máy chủ mà mã này được gọi phải đặt đồng hồ chính xác và được đồng bộ hoá.Mặc dù việc này sẽ thu hồi tất cả các phiên của một người dùng được chỉ định và vô hiệu hoá mọi mã thông báo ID mới cho các phiên hiện có khỏi việc tạo ra, nhưng các mã thông báo ID hiện có có thể vẫn hoạt động cho đến khi hết hạn tự nhiên (một giờ). Để xác minh rằng mã thông báo nhận dạng đã bị thu hồi, hãy sử dụng BaseAuth.verifyIdToken(), trong đó giá trị checkRevoked được đặt thành true. |
|
| setCustomUserClaims(uid, customUserClaims) | Thiết lập thêm thông báo xác nhận quyền sở hữu của nhà phát triển đối với một người dùng hiện có được xác định bằng uid được cung cấp. Thông tin này thường dùng để xác định vai trò và cấp truy cập của người dùng. Những thông báo xác nhận quyền sở hữu này phải áp dụng cho mọi thiết bị mà người dùng đã đăng nhập (sau khi mã thông báo hết hạn hoặc khi mã thông báo bị buộc làm mới) và vào lần đăng nhập tiếp theo của người dùng. Nếu bạn sử dụng tên xác nhận quyền sở hữu OIDC dành riêng (sub, iat, iss, v.v.), thì hệ thống sẽ báo lỗi. Các quy tắc này được đặt trên mã thông báo mã nhận dạng JWT của người dùng đã xác thực.Hãy xem bài viết Xác định vai trò của người dùng và cấp truy cập để xem các mã mẫu và tài liệu chi tiết. |
|
| updateProviderConfig(providerId, updatedConfig) | Trả về một lời hứa sẽ giải quyết bằng AuthProviderConfig đã cập nhật tương ứng với mã nhận dạng nhà cung cấp được chỉ định. Nếu mã được chỉ định không tồn tại, lỗi auth/configuration-not-found sẽ được gửi đi.Dịch vụ hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP. |
|
| updateUser(uid; thuộc tính) | Cập nhật một người dùng hiện tại.Xem phần Cập nhật người dùng để xem các mã mẫu và tài liệu chi tiết. | |
| verifyIdToken(idToken, checkRevocationd) | Xác minh mã thông báo mã nhận dạng Firebase (JWT). Nếu mã thông báo hợp lệ, lời hứa sẽ được thực hiện bằng các xác nhận quyền sở hữu đã giải mã của mã thông báo; nếu không, lời hứa sẽ bị từ chối.Nếu checkRevoked được đặt thành đúng, trước tiên sẽ xác minh xem người dùng tương ứng có bị vô hiệu hoá hay không. Nếu có, hệ thống sẽ gửi một lỗi auth/user-disabled. Nếu không, sẽ xác minh xem phiên tương ứng với mã thông báo mã nhận dạng đã bị thu hồi hay chưa. Nếu phiên hoạt động của người dùng tương ứng không hợp lệ, hệ thống sẽ gửi lỗi auth/id-token-revoked. Nếu bạn không chỉ định, quy trình kiểm tra sẽ không được áp dụng.Hãy xem bài viết Xác minh mã thông báo nhận dạng để xem các mã mẫu và tài liệu chi tiết. |
|
| verifySessionCookie(sessionCookie, kiểm traĐã thu hồi) | Xác minh cookie trong phiên Firebase. Trả về một Promise (Lời hứa) kèm theo các xác nhận quyền sở hữu cookie. Từ chối lời hứa nếu không thể xác minh cookie.Nếu bạn đặt checkRevoked thành true, trước tiên, hãy xác minh xem người dùng tương ứng có bị vô hiệu hoá hay không: Nếu có, hệ thống sẽ gửi lỗi auth/user-disabled. Nếu không, hãy xác minh xem phiên tương ứng với cookie của phiên có bị thu hồi hay không. Nếu phiên hoạt động của người dùng tương ứng không hợp lệ, hệ thống sẽ gửi lỗi auth/session-cookie-revoked. Nếu bạn không chỉ định, quá trình kiểm tra sẽ không được thực hiện.Hãy xem Xác minh cookie phiên để biết mã mẫu và tài liệu chi tiết |
BaseAuth.createCustomToken()
Tạo một mã thông báo tuỳ chỉnh (JWT) mới của Firebase. Mã này có thể được gửi lại thiết bị khách để sử dụng cho việc đăng nhập bằng phương thức signInWithCustomToken() của SDK ứng dụng. (Các thực thể nhận biết người thuê cũng sẽ nhúng mã nhận dạng người thuê vào mã thông báo.)
Xem bài viết Tạo mã thông báo tuỳ chỉnh để tham khảo các mã mẫu và tài liệu chi tiết.
Chữ ký:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhận dạng cá nhân | chuỗi | uid để dùng làm tiêu đề của mã thông báo tuỳ chỉnh. |
| Xác nhận quyền sở hữu của nhà phát triển | đối tượng | Các thông báo xác nhận quyền sở hữu bổ sung (không bắt buộc) để đưa vào tải trọng của mã thông báo tuỳ chỉnh. |
Trường hợp trả lại hàng:
Hứa hẹn<string>
Lời hứa được thực hiện bằng một mã thông báo tuỳ chỉnh cho uid và tải trọng đã cung cấp.
BaseAuth.createProviderConfig()
Trả về một lời hứa sẽ giải quyết bằng AuthProviderConfig mới tạo khi tạo cấu hình nhà cung cấp mới.
Để hỗ trợ nhà cung cấp SAML và OIDC, bạn phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP.
Chữ ký:
createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| cấu hình | AuthProviderConfig | Cấu hình nhà cung cấp cần tạo. |
Trường hợp trả lại hàng:
Hứa hẹn<AuthProviderConfig>
Một lời hứa sẽ giải quyết bằng cấu hình nhà cung cấp đã tạo.
BaseAuth.createSessionCookie()
Tạo cookie phiên mới trên Firebase có các lựa chọn được chỉ định. Bạn có thể đặt chuỗi JWT đã tạo làm cookie phiên phía máy chủ với chính sách cookie tuỳ chỉnh và dùng để quản lý phiên. Cookie phiên JWT sẽ có cùng các xác nhận quyền sở hữu tải trọng như mã thông báo giá trị nhận dạng được cung cấp.
Xem phần Quản lý cookie phiên để xem mã mẫu và tài liệu chi tiết.
Chữ ký:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã thông báo | chuỗi | Mã thông báo mã Firebase để đổi lấy cookie của phiên. |
| sessionCookieOptions | SessionCookieOptions | Các lựa chọn cookie phiên, bao gồm cả thời lượng phiên tuỳ chỉnh. |
Trường hợp trả lại hàng:
Hứa hẹn<string>
Lời hứa sẽ mang lại sự thành công khi sử dụng cookie phiên được tạo.
BaseAuth.createUser()
Tạo một người dùng mới.
Hãy xem phần Tạo người dùng để biết các mã mẫu và tài liệu chi tiết.
Chữ ký:
createUser(properties: CreateRequest): Promise<UserRecord>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| thuộc tính | Tạo yêu cầu | Các thuộc tính cần đặt trên bản ghi người dùng mới sẽ được tạo. |
Trường hợp trả lại hàng:
Cam kết<UserRecord>
Lời hứa được thực hiện bằng dữ liệu người dùng tương ứng với người dùng mới được tạo.
BaseAuth.deleteProviderConfig()
Xoá cấu hình của nhà cung cấp tương ứng với mã nhà cung cấp đã chuyển. Nếu mã nhận dạng được chỉ định không tồn tại, hệ thống sẽ gửi ra lỗi auth/configuration-not-found.
Để hỗ trợ nhà cung cấp SAML và OIDC, bạn phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP.
Chữ ký:
deleteProviderConfig(providerId: string): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhà cung cấp | chuỗi | Mã nhà cung cấp tương ứng với cấu hình nhà cung cấp cần xoá. |
Trường hợp trả lại hàng:
Hứa hẹn<void>
Một lời hứa sẽ quyết định khi hoàn thành.
BaseAuth.deleteUser()
Xoá người dùng hiện tại.
Xem phần Xoá người dùng để xem mã mẫu và tài liệu chi tiết.
Chữ ký:
deleteUser(uid: string): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhận dạng cá nhân | chuỗi | uid tương ứng với người dùng cần xoá. |
Trường hợp trả lại hàng:
Hứa hẹn<void>
Lời hứa trống được thực hiện sau khi người dùng bị xoá.
BaseAuth.deleteUsers()
Xoá người dùng do các uid nhất định chỉ định.
Việc xoá một người dùng không tồn tại sẽ không gây ra lỗi (tức là phương thức này không thay đổi giá trị). Những người dùng hiện tại được coi là đã xoá thành công, nên sẽ được tính vào giá trị DeleteUsersResult.successCount.
Bạn chỉ có thể cung cấp tối đa 1.000 giá trị nhận dạng. Nếu bạn cung cấp hơn 1.000 giá trị nhận dạng, thì phương thức này sẽ gửi ra lỗi FirebaseAuthError.
API này hiện bị giới hạn tốc độ ở máy chủ ở 1 QPS. Nếu vượt quá hạn mức này, bạn có thể gặp lỗi vượt quá hạn mức. Do đó, nếu muốn xoá hơn 1.000 người dùng, bạn có thể cần thêm độ trễ để đảm bảo bạn không vượt quá giới hạn này.
Chữ ký:
deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| uid | chuỗi[] | uids tương ứng với người dùng cần xoá. |
Trường hợp trả lại hàng:
Hứa hẹn<DeleteUsersResult>
Lời hứa giải quyết tổng số lần xóa thành công/không thành công, cũng như mảng lỗi tương ứng với lần xóa không thành công.
BaseAuth.generateEmailVerifyLink()
Tạo đường liên kết đến thao tác bên ngoài email để xác minh quyền sở hữu của người dùng đối với email đã chỉ định. Đối tượng ActionCodeSettings được cung cấp dưới dạng một đối số cho phương thức này xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý cùng với thông tin bổ sung về trạng thái sẽ được truyền trong đường liên kết sâu hay không, v.v.
Chữ ký:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| chuỗi | Tài khoản email cần xác minh. | |
| Cài đặt mã hành động | ActionCodeSettings | Chế độ cài đặt mã hành động. Nếu được chỉ định, URL trạng thái/tiếp tục sẽ được đặt làm tham số "continueUrl" trong đường liên kết xác minh email. Trang đích xác minh email mặc định sẽ sử dụng trang này để hiển thị một đường liên kết quay lại ứng dụng nếu đã cài đặt. Nếu bạn không chỉ định actionCodeSettings thì sẽ không có URL nào được nối thêm vào URL hành động. URL trạng thái được cung cấp phải thuộc một miền mà nhà phát triển đã đưa vào danh sách cho phép trong bảng điều khiển. Nếu không, hệ thống sẽ gửi lỗi. Tính năng chuyển hướng ứng dụng dành cho thiết bị di động chỉ áp dụng nếu nhà phát triển định cấu hình và chấp nhận điều khoản dịch vụ của Đường liên kết động của Firebase. Hệ thống chỉ tuân thủ tên gói Android và mã nhận dạng gói iOS nếu các thông tin này được định cấu hình trong cùng một dự án Xác thực Firebase. |
Trường hợp trả lại hàng:
Hứa hẹn<string>
Lời hứa sẽ giải quyết bằng đường liên kết đã tạo.
Ví dụ
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generatePasswordResetLink()
Tạo đường liên kết đến thao tác bên ngoài email để đặt lại mật khẩu của người dùng. Đường liên kết sẽ được tạo cho người dùng có địa chỉ email đã chỉ định. Đối tượng ActionCodeSettings không bắt buộc xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý hay không và thông tin bổ sung về trạng thái sẽ được truyền vào đường liên kết sâu, v.v.
Chữ ký:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| chuỗi | Địa chỉ email của người dùng có mật khẩu cần được đặt lại. | |
| Cài đặt mã hành động | ActionCodeSettings | Chế độ cài đặt mã hành động. Nếu được chỉ định, URL trạng thái/tiếp tục sẽ được đặt thành tham số "continueUrl" trong đường liên kết đặt lại mật khẩu. Trang đích đặt lại mật khẩu mặc định sẽ sử dụng trang này để hiển thị một đường liên kết quay lại ứng dụng nếu người dùng đã cài đặt ứng dụng. Nếu bạn không chỉ định actionCodeSettings thì sẽ không có URL nào được nối thêm vào URL hành động. URL trạng thái được cung cấp phải thuộc một miền mà nhà phát triển đã đưa vào danh sách cho phép trong bảng điều khiển. Nếu không, hệ thống sẽ gửi lỗi. Tính năng chuyển hướng ứng dụng dành cho thiết bị di động chỉ áp dụng nếu nhà phát triển định cấu hình và chấp nhận điều khoản dịch vụ của Đường liên kết động của Firebase. Hệ thống chỉ tuân thủ tên gói Android và mã nhận dạng gói iOS nếu các thông tin này được định cấu hình trong cùng một dự án Xác thực Firebase. |
Trường hợp trả lại hàng:
Hứa hẹn<string>
Lời hứa sẽ giải quyết bằng đường liên kết đã tạo.
Ví dụ
var 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,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generatePasswordResetLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateSignInWithEmailLink()
Tạo đường liên kết đến thao tác bên ngoài email để xác minh quyền sở hữu của người dùng đối với email đã chỉ định. Đối tượng ActionCodeSettings được cung cấp dưới dạng một đối số cho phương thức này xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý cùng với thông tin bổ sung về trạng thái sẽ được truyền trong đường liên kết sâu hay không, v.v.
Chữ ký:
generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| chuỗi | Tài khoản email cần xác minh. | |
| Cài đặt mã hành động | ActionCodeSettings | Chế độ cài đặt mã hành động. Nếu được chỉ định, URL trạng thái/tiếp tục sẽ được đặt làm tham số "continueUrl" trong đường liên kết xác minh email. Trang đích xác minh email mặc định sẽ sử dụng trang này để hiển thị một đường liên kết quay lại ứng dụng nếu đã cài đặt. Nếu bạn không chỉ định actionCodeSettings thì sẽ không có URL nào được nối thêm vào URL hành động. URL trạng thái được cung cấp phải thuộc một miền mà nhà phát triển đã đưa vào danh sách cho phép trong bảng điều khiển. Nếu không, hệ thống sẽ gửi lỗi. Tính năng chuyển hướng ứng dụng dành cho thiết bị di động chỉ áp dụng nếu nhà phát triển định cấu hình và chấp nhận điều khoản dịch vụ của Đường liên kết động của Firebase. Hệ thống chỉ tuân thủ tên gói Android và mã nhận dạng gói iOS nếu các thông tin này được định cấu hình trong cùng một dự án Xác thực Firebase. |
Trường hợp trả lại hàng:
Hứa hẹn<string>
Lời hứa sẽ giải quyết bằng đường liên kết đã tạo.
Ví dụ
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateVerifyAndChangeEmailLink()
Tạo một đường liên kết đến hành động liên quan đến email ngoài phạm vi để xác minh quyền sở hữu của người dùng đối với email đã chỉ định. Đối tượng ActionCodeSettings được cung cấp dưới dạng một đối số cho phương thức này xác định liệu đường liên kết có được ứng dụng hoặc trình duyệt dành cho thiết bị di động xử lý cùng với thông tin bổ sung về trạng thái sẽ được truyền trong đường liên kết sâu hay không, v.v.
Chữ ký:
generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| chuỗi | Tài khoản email hiện tại. | |
| email mới | chuỗi | Địa chỉ email đang được cập nhật tài khoản. |
| Cài đặt mã hành động | ActionCodeSettings | Chế độ cài đặt mã hành động. Nếu được chỉ định, URL trạng thái/tiếp tục sẽ được đặt làm tham số "continueUrl" trong đường liên kết xác minh email. Trang đích xác minh email mặc định sẽ sử dụng trang này để hiển thị một đường liên kết quay lại ứng dụng nếu đã cài đặt. Nếu bạn không chỉ định actionCodeSettings thì sẽ không có URL nào được nối thêm vào URL hành động. URL trạng thái đã cung cấp phải thuộc một miền được cấp quyền trong bảng điều khiển, nếu không, bạn sẽ gặp lỗi. Tính năng chuyển hướng ứng dụng dành cho thiết bị di động chỉ áp dụng nếu nhà phát triển định cấu hình và chấp nhận điều khoản dịch vụ của Đường liên kết động của Firebase. Hệ thống chỉ tuân thủ tên gói Android và mã nhận dạng gói iOS nếu các thông tin này được định cấu hình trong cùng một dự án Xác thực Firebase. |
Trường hợp trả lại hàng:
Hứa hẹn<string>
Lời hứa sẽ giải quyết bằng đường liên kết đã tạo.
BaseAuth.getProviderConfig()
Tra cứu cấu hình của nhà cung cấp dịch vụ xác thực theo mã nhận dạng được cung cấp. Trả về một lời hứa sẽ giải quyết bằng cấu hình nhà cung cấp tương ứng với mã nhà cung cấp đã chỉ định. Nếu mã nhận dạng được chỉ định không tồn tại, hệ thống sẽ gửi ra lỗi auth/configuration-not-found.
Để hỗ trợ nhà cung cấp SAML và OIDC, bạn phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP.
Chữ ký:
getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhà cung cấp | chuỗi | Mã nhà cung cấp tương ứng với cấu hình nhà cung cấp cần trả về. |
Trường hợp trả lại hàng:
Hứa hẹn<AuthProviderConfig>
Cam kết sẽ giải quyết bằng cấu hình tương ứng với mã nhận dạng được cung cấp.
BaseAuth.getUser()
Lấy dữ liệu người dùng tương ứng với một uid nhất định.
Xem phần Truy xuất dữ liệu người dùng để tham khảo các mã mẫu và tài liệu chi tiết.
Chữ ký:
getUser(uid: string): Promise<UserRecord>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhận dạng cá nhân | chuỗi | uid tương ứng với người dùng có dữ liệu cần tìm nạp. |
Trường hợp trả lại hàng:
Cam kết<UserRecord>
Lời hứa được thực hiện bằng dữ liệu người dùng tương ứng với uid mà bạn cung cấp.
BaseAuth.getUserByEmail()
Lấy dữ liệu người dùng tương ứng với một email nhất định.
Xem phần Truy xuất dữ liệu người dùng để tham khảo các mã mẫu và tài liệu chi tiết.
Chữ ký:
getUserByEmail(email: string): Promise<UserRecord>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| chuỗi | Email tương ứng với người dùng có dữ liệu cần tìm nạp. |
Trường hợp trả lại hàng:
Cam kết<UserRecord>
Lời hứa được thực hiện bằng dữ liệu người dùng tương ứng với email mà bạn cung cấp.
BaseAuth.getUserByPhoneNumber()
Lấy dữ liệu người dùng tương ứng với một số điện thoại nhất định. Số điện thoại phải tuân theo quy cách E.164.
Xem phần Truy xuất dữ liệu người dùng để tham khảo các mã mẫu và tài liệu chi tiết.
Chữ ký:
getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| số điện thoại | chuỗi | Số điện thoại tương ứng với người dùng có dữ liệu cần tìm nạp. |
Trường hợp trả lại hàng:
Cam kết<UserRecord>
Lời hứa được thực hiện bằng dữ liệu người dùng tương ứng với số điện thoại đã cung cấp.
BaseAuth.getUserByProviderUid()
Lấy dữ liệu người dùng của người dùng tương ứng với một mã nhà cung cấp nhất định.
Xem phần Truy xuất dữ liệu người dùng để tham khảo các mã mẫu và tài liệu chi tiết.
Chữ ký:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhà cung cấp | chuỗi | Mã nhà cung cấp, ví dụ: "google.com" cho nhà cung cấp của Google. |
| mã nhận dạng cá nhân | chuỗi | Giá trị nhận dạng người dùng của nhà cung cấp cụ thể. |
Trường hợp trả lại hàng:
Cam kết<UserRecord>
Lời hứa được thực hiện bằng dữ liệu người dùng tương ứng với mã nhà cung cấp nhất định.
BaseAuth.getUsers()
Lấy dữ liệu người dùng tương ứng với các giá trị nhận dạng đã chỉ định.
Không có đảm bảo về thứ tự; cụ thể là mục nhập thứ n trong danh sách kết quả không đảm bảo tương ứng với mục nhập thứ n trong danh sách tham số đầu vào.
Bạn chỉ có thể cung cấp tối đa 100 giá trị nhận dạng. Nếu bạn cung cấp hơn 100 giá trị nhận dạng, thì phương thức này sẽ gửi ra lỗi FirebaseAuthError.
Chữ ký:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| giá trị nhận dạng | UserIdentifier[] | Giá trị nhận dạng dùng để cho biết bản ghi người dùng nào sẽ được trả về. Không được có nhiều hơn 100 mục nhập. |
Trường hợp trả lại hàng:
Hứa hẹn<GetUsersResult>
Cam kết giải quyết các bản ghi người dùng tương ứng.
Trường hợp ngoại lệ
FirebaseAuthError Nếu có bất kỳ giá trị nhận dạng nào không hợp lệ hoặc nếu có hơn 100 giá trị nhận dạng được chỉ định.
BaseAuth.importUsers()
Nhập danh sách người dùng được cung cấp vào Firebase Auth. Bạn chỉ được phép nhập tối đa 1.000 người dùng cùng một lúc. Khi nhập người dùng bằng mật khẩu, bạn phải chỉ định UserImportOptions. Thao tác này được tối ưu hoá cho tính năng nhập hàng loạt và sẽ bỏ qua các bước kiểm tra trên uid, email cũng như các giá trị nhận dạng duy nhất khác có thể dẫn đến trùng lặp.
Chữ ký:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| người-dùng | UserImportRecord[] | Danh sách hồ sơ người dùng cần nhập vào Xác thực Firebase. |
| tuỳ chọn | UserImportOptions | Tuỳ chọn nhập người dùng, bắt buộc khi người dùng cung cấp bao gồm thông tin đăng nhập mật khẩu. |
Trường hợp trả lại hàng:
Hứa hẹn<UserImportResult>
Một lời hứa sẽ giải quyết khi thao tác hoàn tất với kết quả nhập. Dữ liệu này bao gồm số lần nhập thành công, số lần nhập không thành công và lỗi tương ứng.
BaseAuth.listProviderConfigs()
Trả về danh sách cấu hình nhà cung cấp hiện có khớp với bộ lọc đã cung cấp. Bạn có thể liệt kê tối đa 100 cấu hình của nhà cung cấp cùng một lúc.
Để hỗ trợ nhà cung cấp SAML và OIDC, bạn phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP.
Chữ ký:
listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| tuỳ chọn | AuthProviderConfigFilter | Bộ lọc cấu hình của nhà cung cấp sẽ được áp dụng. |
Trường hợp trả lại hàng:
Hứa hẹn<ListProviderConfigResults>
Lời hứa sẽ giải quyết bằng danh sách cấu hình của nhà cung cấp đáp ứng các yêu cầu về bộ lọc.
BaseAuth.listUsers()
Truy xuất danh sách người dùng (chỉ một lô) có kích thước maxResults bắt đầu từ mức chênh lệch do pageToken chỉ định. Tệp này dùng để truy xuất hàng loạt tất cả người dùng của một dự án được chỉ định.
Xem phần Liệt kê tất cả người dùng để xem mã mẫu và tài liệu chi tiết.
Chữ ký:
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| kết quả tối đa | số | Kích thước trang là 1000 nếu không xác định. Đây cũng là giới hạn tối đa cho phép. |
| mã thông báo trang | chuỗi | Mã thông báo trang tiếp theo. Nếu không được chỉ định, sẽ trả về người dùng bắt đầu mà không có chênh lệch nào. |
Trường hợp trả lại hàng:
Hứa hẹn<ListUsersResult>
Lời hứa sẽ giải quyết lô người dùng hiện tại đã tải xuống và mã thông báo trang tiếp theo.
BaseAuth.revokeRefreshTokens()
Thu hồi tất cả mã làm mới của người dùng hiện có.
API này sẽ cập nhật UserRecord.tokensValidAfterTime của người dùng thành giờ UTC hiện tại. Điều quan trọng là máy chủ mà hàm này được gọi phải có đồng hồ được đặt chính xác và được đồng bộ hoá.
Mặc dù việc này sẽ thu hồi tất cả các phiên của một người dùng đã chỉ định và vô hiệu hoá mọi mã thông báo giá trị nhận dạng mới cho các phiên hiện có được tạo, nhưng các mã thông báo giá trị nhận dạng hiện có có thể vẫn hoạt động cho đến khi hết hạn tự nhiên (một giờ). Để xác minh rằng mã thông báo nhận dạng đã bị thu hồi, hãy sử dụng BaseAuth.verifyIdToken(), trong đó giá trị checkRevoked được đặt thành true.
Chữ ký:
revokeRefreshTokens(uid: string): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhận dạng cá nhân | chuỗi | uid tương ứng với người dùng có mã làm mới cần được thu hồi. |
Trường hợp trả lại hàng:
Hứa hẹn<void>
Lời hứa trống được thực hiện sau khi mã thông báo làm mới của người dùng bị thu hồi.
BaseAuth.setCustomUserClaims()
Đặt thêm thông báo xác nhận quyền sở hữu của nhà phát triển đối với một người dùng hiện có được xác định bằng uid được cung cấp. Thông tin này thường dùng để xác định vai trò và cấp truy cập của người dùng. Những thông báo xác nhận quyền sở hữu này phải áp dụng cho mọi thiết bị mà người dùng đã đăng nhập (sau khi mã thông báo hết hạn hoặc khi mã thông báo bị buộc làm mới) và vào lần đăng nhập tiếp theo của người dùng. Nếu bạn sử dụng tên xác nhận quyền sở hữu OIDC dành riêng (sub, iat, iss, v.v.), thì hệ thống sẽ báo lỗi. Các khoá này được đặt trên mã thông báo nhận dạng JWT của người dùng đã xác thực.
Hãy xem phần Xác định vai trò của người dùng và cấp truy cập để biết mã mẫu và tài liệu chi tiết.
Chữ ký:
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhận dạng cá nhân | chuỗi | uid của người dùng để chỉnh sửa. |
| Tuỳ chỉnh người dùng xác nhận quyền sở hữu | đối tượng | giá trị rỗng | Nhà phát triển tuyên bố đã đặt. Nếu giá trị rỗng được truyền, các thông báo xác nhận quyền sở hữu tuỳ chỉnh hiện có sẽ bị xoá. Nếu tải trọng của thông báo xác nhận quyền sở hữu tuỳ chỉnh lớn hơn 1000 byte thì sẽ xảy ra lỗi. Thông báo xác nhận quyền sở hữu tuỳ chỉnh được thêm vào mã thông báo nhận dạng của người dùng. Mã này được truyền theo mọi yêu cầu đã xác thực. Đối với các thuộc tính người dùng có liên quan đến hồ sơ không có quyền truy cập, hãy sử dụng cơ sở dữ liệu hoặc các hệ thống lưu trữ riêng biệt khác. |
Trường hợp trả lại hàng:
Hứa hẹn<void>
Một lời hứa sẽ giải quyết khi thao tác hoàn tất thành công.
BaseAuth.updateProviderConfig()
Trả về một lời hứa sẽ giải quyết bằng AuthProviderConfig đã cập nhật tương ứng với mã nhận dạng nhà cung cấp được chỉ định. Nếu mã nhận dạng được chỉ định không tồn tại, hệ thống sẽ gửi ra lỗi auth/configuration-not-found.
Để hỗ trợ nhà cung cấp SAML và OIDC, bạn phải có Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm cả mức giá và tính năng, hãy xem tài liệu về GCIP.
Chữ ký:
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhà cung cấp | chuỗi | Mã nhà cung cấp tương ứng với cấu hình nhà cung cấp cần cập nhật. |
| đã cập nhậtConfig | UpdateAuthProviderRequest | Cấu hình đã cập nhật. |
Trường hợp trả lại hàng:
Hứa hẹn<AuthProviderConfig>
Cam kết sẽ giải quyết bằng cấu hình nhà cung cấp đã cập nhật.
BaseAuth.updateUser()
Cập nhật người dùng hiện tại.
Xem phần Cập nhật người dùng để biết các mã mẫu và tài liệu chi tiết.
Chữ ký:
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã nhận dạng cá nhân | chuỗi | uid tương ứng với người dùng cần cập nhật. |
| thuộc tính | UpdateRequest | Các thuộc tính cần cập nhật dựa trên người dùng được cung cấp. |
Trường hợp trả lại hàng:
Cam kết<UserRecord>
Một lời hứa được thực hiện với dữ liệu người dùng được cập nhật.
BaseAuth.verifyIdToken()
Xác minh mã thông báo mã nhận dạng Firebase (JWT). Nếu mã thông báo hợp lệ, lời hứa sẽ được thực hiện bằng các tuyên bố đã giải mã của mã thông báo; nếu không, lời hứa sẽ bị từ chối.
Nếu bạn đặt checkRevoked thành true, trước tiên, hãy xác minh xem người dùng tương ứng có bị vô hiệu hoá hay không. Nếu có, hệ thống sẽ gửi một lỗi auth/user-disabled. Nếu không, sẽ xác minh xem phiên tương ứng với mã thông báo mã nhận dạng đã bị thu hồi hay chưa. Nếu phiên hoạt động của người dùng tương ứng không hợp lệ, hệ thống sẽ gửi lỗi auth/id-token-revoked. Nếu bạn không chỉ định, việc kiểm tra sẽ không được áp dụng.
Xem bài viết Xác minh mã thông báo giá trị nhận dạng để biết các mã mẫu và tài liệu chi tiết.
Chữ ký:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| mã thông báo | chuỗi | Mã thông báo giá trị nhận dạng cần xác minh. |
| Đã thu hồi séc | boolean | Kiểm tra xem mã thông báo giá trị nhận dạng đã bị thu hồi hay chưa. Việc này đòi hỏi bạn phải gửi thêm yêu cầu tới phần phụ trợ Xác thực Firebase để kiểm tra thời gian tokensValidAfterTime cho người dùng tương ứng. Khi không được chỉ định, việc kiểm tra bổ sung này không được áp dụng. |
Trường hợp trả lại hàng:
Hứa hẹn<DecodedIdToken>
Lời hứa được thực hiện bằng các xác nhận quyền sở hữu đã giải mã của mã thông báo nếu mã thông báo giá trị nhận dạng hợp lệ; nếu không, là một lời hứa bị từ chối.
BaseAuth.verifySessionCookie()
Xác minh cookie trong phiên Firebase. Trả về một Promise (Lời hứa) kèm theo các xác nhận quyền sở hữu cookie. Từ chối lời hứa nếu không thể xác minh cookie.
Nếu bạn đặt checkRevoked thành true, thì trước tiên, sẽ xác minh xem người dùng tương ứng có bị vô hiệu hoá hay không: Nếu có, hệ thống sẽ gửi ra lỗi auth/user-disabled. Nếu không, hãy xác minh xem phiên tương ứng với cookie của phiên có bị thu hồi hay không. Nếu phiên hoạt động của người dùng tương ứng không hợp lệ, hệ thống sẽ gửi lỗi auth/session-cookie-revoked. Nếu bạn không chỉ định thì việc kiểm tra sẽ không được thực hiện.
Xem phần Xác minh cookie phiên để biết các mã mẫu và tài liệu chi tiết
Chữ ký:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| cookie của phiên | chuỗi | Cookie phiên cần xác minh. |
| Đã thu hồi séc | boolean |
Trường hợp trả lại hàng:
Hứa hẹn<DecodedIdToken>
Lời hứa được thực hiện bằng các xác nhận quyền sở hữu được giải mã của cookie của phiên nếu cookie của phiên hợp lệ; nếu không, là một lời hứa bị từ chối.