Trang này được dịch bởi Cloud Translation API.

firebase-admin.auth package

Xác thực Firebase.

Hàm

Chức năng	Mô tả
getAuth(ứng dụng)	Nhận dịch vụ Xác thực cho ứng dụng mặc định hoặc một ứng dụng nhất định.`getAuth()` có thể được gọi mà không cần đối số để truy cập dịch vụ Xác thực của ứng dụng mặc định hoặc dưới dạng `getAuth(app)` để truy cập dịch vụ Xác thực được liên kết với một ứng dụng cụ thể.

Lớp học

Hạng	Mô tả
Xác thực	Dịch vụ xác thực được liên kết với ứng dụng đã cung cấp. Một thực thể Xác thực có thể có nhiều đối tượng thuê.
AuthClientErrorCode	Mã lỗi ứng dụng xác thực và thông báo mặc định của các lỗi đó.
BaseAuth	Giao diện mẹ phổ biến cho cả API `Auth` và `TenantAwareAuth`.
FirebaseAuthError	Cấu trúc mã lỗi Xác thực Firebase. Thao tác này mở rộng PrefixedFirebaseError.
Thông tin đa yếu tố	Giao diện thể hiện các thuộc tính phổ biến của một yếu tố thứ hai đã được người dùng đăng ký.
Chế độ cài đặt đa yếu tố	Chế độ cài đặt người dùng liên quan đến đa yếu tố.
PhoneMultiFactorInfo	Giao diện đại diện cho một yếu tố thứ hai mà người dùng đã đăng ký cho một điện thoại cụ thể.
Cấu hình dự án	Biểu thị một cấu hình dự án.
ProjectConfigManager	Quản lý (lấy và cập nhật) cấu hình dự án hiện tại.
Người thuê nhà	Đại diện cho một cấu hình đối tượng thuê.Hỗ trợ nhiều đối tượng thuê yêu cầu phải có Nền tảng nhận dạng của Google Cloud (GCIP). Để tìm hiểu thêm về GCIP, bao gồm cả giá và các tính năng, hãy xem tài liệu về GCIP.Trước khi có thể sử dụng GCIP cho nhiều khách hàng trong một dự án Google Cloud Identity Platform, người thuê phải được cho phép trong dự án đó thông qua giao diện người dùng Cloud Console.Cấu hình đối tượng thuê cung cấp các thông tin như tên hiển thị, giá trị nhận dạng đối tượng thuê và cấu hình xác thực email. Để quản lý cấu hình của nhà cung cấp dịch vụ OIDC/SAML, bạn nên sử dụng các thực thể `TenantAwareAuth` thay vì `Tenant` để truy xuất danh sách các IdP đã định cấu hình trên một đối tượng thuê. Khi thiết lập các nhà cung cấp này, xin lưu ý rằng người thuê sẽ kế thừa các miền có trong danh sách cho phép và URI chuyển hướng đã xác thực của dự án mẹ.Tất cả các chế độ cài đặt khác của đối tượng thuê cũng sẽ được kế thừa. Bạn cần quản lý các thông tin này từ giao diện người dùng Cloud Console.
TenantAwareAuth	Giao diện `Auth` nhận biết người thuê được dùng để quản lý người dùng, định cấu hình nhà cung cấp dịch vụ SAML/OIDC, tạo đường liên kết đến email để đặt lại mật khẩu, xác minh email, v.v. cho những đối tượng thuê cụ thể.Dịch vụ hỗ trợ đa khách hàng 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à các tính năng, hãy xem tài liệu về GCIP.Mỗi đối tượng thuê đều có các nhà cung cấp danh tính, chế độ cài đặt và nhóm người dùng riêng. Khi sử dụng `TenantAwareAuth`, bạn cũng có thể quản lý người dùng của một đối tượng thuê cụ thể và cấu hình OIDC/SAML tương ứng, xác minh mã thông báo nhận dạng của người dùng đã đăng nhập vào một đối tượng thuê cụ thể và tạo đường liên kết hành động qua email cho người dùng thuộc đối tượng thuê đó.Bạn có thể tạo thực thể `TenantAwareAuth` cho một `tenantId` cụ thể bằng cách gọi TenantManager.authForTenant().
TenantManager	Xác định người quản lý đối tượng thuê được dùng để giúp quản lý các hoạt động liên quan đến đối tượng thuê. Nội dung này bao gồm: Có thể tạo, cập nhật, liệt kê, nhận và xoá đối tượng thuê cho dự án cơ bản. Lấy một thực thể `TenantAwareAuth` để chạy các hoạt động liên quan đến tính năng Xác thực (quản lý người dùng, quản lý cấu hình nhà cung cấp, xác minh mã thông báo, tạo đường liên kết email, v.v.) trong bối cảnh của đối tượng thuê được chỉ định.
Thông tin người dùng	Đại diện cho thông tin của người dùng từ một nhà cung cấp danh tính bên thứ ba như Google hoặc Facebook.
Siêu dữ liệu người dùng	Biểu thị siêu dữ liệu của người dùng.
Bản ghi người dùng	Đại diện cho người dùng.

Giao diện

Giao diện	Mô tả
ActionCodeSettings	Đây là giao diện xác định URL tiếp tục/trạng thái bắt buộc bằng giá trị nhận dạng gói Android và iOS không bắt buộc.
AllowByDefault (Cho phép theo mặc định)	Xác định chính sách cho phép mọi khu vực theo mặc định và thêm các khu vực không được phép vào danh sách không cho phép.
AllowByDefaultWrap	Cấu hình khu vực SMS độc quyền chung cho giao diện AllowByDefault
Chỉ danh sách cho phép	Xác định chính sách chỉ cho phép các khu vực bằng cách thêm các khu vực đó vào danh sách cho phép một cách rõ ràng.
AllowlistOnlyWrap	Cấu hình khu vực SMS độc quyền cùng lúc trên giao diện AllowlistOnly
AuthProviderConfigFilter	Giao diện bộ lọc được dùng để thiết lập danh sách nhà cung cấp. Mã này được dùng khi chỉ định cách liệt kê các nhà cung cấp danh tính đã định cấu hình qua BaseAuth.listProviderConfigs().
BaseAuthProviderConfig	Giao diện cấu hình của nhà cung cấp dịch vụ Xác thực cơ sở.
BaseCreateMultiFactorInfoRequest	Giao diện đại diện cho các thuộc tính cơ sở của một yếu tố thứ hai đã được người dùng đăng ký cho `CreateRequest`.
BaseUpdateMultiFactorInfoRequest	Giao diện đại diện cho các thuộc tính phổ biến của một yếu tố thứ hai đã được người dùng đăng ký cho một `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest	Giao diện đại diện cho một yếu tố thứ hai mà người dùng đã đăng ký (cho một điện thoại cụ thể) của `CreateRequest`.
CreateRequest	Giao diện mô tả các thuộc tính để thiết lập trên một bản ghi người dùng mới sẽ được tạo.
CustomStrengthOptionsConfig	Các quy tắc ràng buộc cần thực thi đối với chính sách mật khẩu
DeMã hoáAuthBlockingToken
Mã thông báo mã đã giải mã	Giao diện đại diện cho mã thông báo giá trị nhận dạng Firebase đã giải mã, được trả về từ phương thức BaseAuth.verifyIdToken().Mã nhận dạng Firebase là Mã thông báo web JSON (JWT) tuân thủ quy cách của OpenID Connect. Xem [phần Mã thông báo mã nhận dạng trong thông số kỹ thuật SSO Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) để biết thêm thông tin về các thuộc tính cụ thể bên dưới.
DeleteUsersResult	Đại diện cho kết quả của BaseAuth.deleteUsers(). API.
EmailIdentifier	Dùng để tra cứu tài khoản qua email.Hãy xem BaseAuth.getUsers().
EmailPrivacyConfig	Cấu hình quyền riêng tư trong email của một dự án hoặc đối tượng thuê.
EmailSignInProviderConfig	Cấu hình của nhà cung cấp dịch vụ đăng nhập qua email.
GetUsersResult	Biểu thị kết quả của API BaseAuth.getUsers().
ListProviderConfigOutcome	Giao diện phản hồi để liệt kê cấu hình của nhà cung cấp. Điều này chỉ có sẵn khi liệt kê tất cả các nhà cung cấp danh tính các cấu hình qua BaseAuth.listProviderConfigs().
ListTenantsResult	Giao diện biểu thị đối tượng được trả về qua thao tác TenantManager.listTenants(). Chứa danh sách đối tượng thuê của lô hiện tại và mã thông báo trang tiếp theo nếu có.
ListUsersResult	Giao diện biểu thị đối tượng được trả về từ thao tác BaseAuth.listUsers(). Chứa danh sách người dùng của lô hiện tại và mã thông báo trang tiếp theo nếu có.
MultiFactorConfig	Giao diện biểu thị cấu hình đa yếu tố. Bạn có thể dùng thông tin này để xác định xem bật hay tắt tính năng xác thực đa yếu tố, cũng như danh sách các thử thách thứ hai được hỗ trợ.
MultiFactorCreateSettings (Cài đặt đa yếu tố)	Chế độ cài đặt người dùng liên quan đến đa yếu tố cho các thao tác tạo.
MultiFactorProviderConfig	Giao diện đại diện cho cấu hình của nhà cung cấp dịch vụ xác thực đa yếu tố. Giao diện này được dùng cho nhà cung cấp dịch vụ xác thực yếu tố thứ hai không phải là SMS. Hiện tại, chỉ có TOTP được hỗ trợ.
MultiFactorUpdateSettings (Cài đặt đa yếu tố)	Chế độ cài đặt người dùng liên quan đến đa yếu tố cho các hoạt động cập nhật.
OAuthResponseType	Giao diện biểu thị đối tượng phản hồi của nhà cung cấp OIDC (OpenID Connect) cho quy trình uỷ quyền OAuth. Một trong các cài đặt sau là bắt buộc: Đặt `code` thành `true` cho quy trình mã. Thiết lập `idToken` thành `true` cho quy trình mã thông báo mã nhận dạng.
OIDCAuthProviderConfig	Giao diện cấu hình của nhà cung cấp dịch vụ xác thực [OIDC](https://openid.net/specs/openid-connect-core-1_0-FINAL.html). Bạn có thể tạo nhà cung cấp OIDC (OpenID Connect) thông qua BaseAuth.createProviderConfig().
OIDCUpdateAuthProviderRequest	Giao diện yêu cầu để cập nhật nhà cung cấp dịch vụ Xác thực OIDC (OpenID Connect). Mã này được sử dụng khi cập nhật cấu hình của nhà cung cấp OIDC thông qua BaseAuth.updateProviderConfig().
PasswordPolicyConfig	Cấu hình chính sách mật khẩu cho dự án hoặc đối tượng thuê
PhoneIdentifier	Dùng để tra cứu tài khoản theo số điện thoại.Xem BaseAuth.getUsers().
ProviderIdentifier	Dùng để tra cứu một tài khoản của nhà cung cấp được liên kết.Xem BaseAuth.getUsers().
ReCAPTCHAConfig	Giao diện yêu cầu để cập nhật Cấu hình reCAPTCHA. Khi bật tính năng Tích hợp reCAPTCHA Enterprise, bạn đồng ý với Thời hạn dịch vụ của reCAPTCHA Enterprise.
ReCAPTCHAKey	Cấu hình khoá reCAPTCHA.
ReCAPTCHAManagedRule	Cấu hình cho quy tắc hành động reCAPTCHA.
SAMLAuthProviderConfig	Giao diện cấu hình của nhà cung cấp dịch vụ Xác thực [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). Bạn có thể tạo nhà cung cấp SAML qua BaseAuth.createProviderConfig().
SAMLUpdateAuthProviderRequest	Giao diện yêu cầu cập nhật nhà cung cấp dịch vụ xác thực SAML. Mã này được dùng khi cập nhật cấu hình của nhà cung cấp SAML thông qua BaseAuth.updateProviderConfig().
SessionCookieOptions	Giao diện biểu thị các tuỳ chọn cookie phiên cần thiết cho phương thức BaseAuth.createSessionCookie().
TotpMultiFactorProviderConfig	Giao diện thể hiện chế độ cài đặt cấu hình cho tính năng xác thực yếu tố thứ hai TOTP.
UidIdentifier	Dùng để tra cứu tài khoản bằng uid.Xem BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest	Giao diện đại diện cho một yếu tố thứ hai mà người dùng đã đăng ký cho một điện thoại cụ thể cho một `UpdateRequest`.
UpdateProjectConfigRequest	Giao diện biểu thị các thuộc tính để cập nhật cấu hình dự án được cung cấp.
UpdateRequest (Yêu cầu cập nhật)	Giao diện biểu thị các thuộc tính để cập nhật về người dùng được cung cấp.
UpdateTenantRequest	Giao diện biểu thị các thuộc tính để cập nhật về đối tượng thuê được cung cấp.
UserImportOptions	Giao diện biểu thị các tuỳ chọn nhập người dùng cần thiết cho phương thức BaseAuth.importUsers(). Thông tin này được dùng để cung cấp thông tin về thuật toán băm mật khẩu.
UserImportRecord	Giao diện đại diện cho người dùng để nhập vào tính năng Xác thực Firebase thông qua phương thức BaseAuth.nhậpUsers().
UserImportResult	Giao diện biểu thị phản hồi từ phương thức BaseAuth.nhậpUsers() để nhập hàng loạt người dùng vào tính năng Xác thực Firebase.
UserMetadataRequest	Siêu dữ liệu người dùng cần đưa vào khi nhập người dùng.
Trình cung cấp người dùng	Biểu thị một nhà cung cấp danh tính người dùng có thể liên kết với một người dùng Firebase.
UserProviderRequest	Dữ liệu nhà cung cấp người dùng cần đưa vào khi nhập người dùng.

Nhập bí danh

Nhập bí danh	Mô tả
AuthFactorType	Xác định loại yếu tố thứ hai.
AuthProviderConfig	Loại cấu hình của nhà cung cấp dịch vụ xác thực. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest	Loại biểu thị các thuộc tính của một yếu tố thứ hai đã được người dùng đăng ký cho `CreateRequest`.
CreateTenantRequest	Giao diện đại diện cho các thuộc tính cần đặt cho một đối tượng thuê mới.
Hàm bămHashAlgorithmType
MultiFactorConfigState (Trạng thái đa yếu tố)	Xác định trạng thái cấu hình đa yếu tố.
PasswordPolicyEnforcementState	Trạng thái thực thi của chính sách mật khẩu.
ReCAPTCHAAction	Những hành động cần thực hiện đối với các yêu cầu được bảo vệ bằng reCAPTCHA. – "BLOCK": Yêu cầu được bảo vệ bằng reCAPTCHA sẽ bị chặn.
ReCAPTCHAKeyClientType	Loại nền tảng của khoá.
RecaptchaProviderProviderExecutionState	Trạng thái thực thi của biện pháp bảo vệ reCAPTCHA. – "TẮT": Không thực thi. – "AUDIT": Tạo bài đánh giá nhưng không thực thi kết quả. – "ENFORCE": Tạo bài đánh giá và thực thi kết quả.
SmsRegionConfig	Giao diện yêu cầu cập nhật Cấu hình khu vực qua SMS. Định cấu hình những khu vực nơi người dùng được phép gửi tin nhắn SMS xác minh. Thông tin này dựa trên mã gọi của số điện thoại đích.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	Loại biểu thị các thuộc tính của một yếu tố thứ hai đã được người dùng đăng ký cho `UpdateRequest`.
Giá trị nhận dạng người dùng	Xác định người dùng cần tra cứu.

getAuth(ứng dụng)

Nhận dịch vụ Xác thực cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

getAuth() có thể được gọi mà không có đối số để truy cập vào dịch vụ Xác thực của ứng dụng mặc định hoặc dưới dạng getAuth(app) để truy cập vào dịch vụ Xác thực được liên kết với một ứng dụng cụ thể.

Chữ ký:

export declare function getAuth(app?: App): Auth;

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng

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

Xác thực

Ví dụ 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

Ví dụ 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

Kiểu xác thực

Xác định loại yếu tố thứ hai.

Chữ ký:

export type AuthFactorType = 'phone';

AuthProviderConfig

Loại cấu hình của nhà cung cấp dịch vụ xác thực. BaseAuth.createProviderConfig().

Chữ ký:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest (Yêu cầu đa yếu tố thông tin)

Loại biểu thị các thuộc tính của một yếu tố thứ hai đã được người dùng đăng ký cho một CreateRequest.

Chữ ký:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

Giao diện đại diện cho các thuộc tính cần đặt cho một đối tượng thuê mới.

Chữ ký:

export type CreateTenantRequest = UpdateTenantRequest;

Loại thuật toán băm

Chữ ký:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

Trạng thái cấu hình đa yếu tố

Xác định trạng thái cấu hình đa yếu tố.

Chữ ký:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

Trạng thái thực thi chính sách mật khẩu

Trạng thái thực thi của chính sách mật khẩu.

Chữ ký:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

Hành động xác thực lại

Những hành động cần thực hiện đối với các yêu cầu được bảo vệ bằng reCAPTCHA. – "BLOCK": Yêu cầu được bảo vệ bằng reCAPTCHA sẽ bị chặn.

Chữ ký:

export type RecaptchaAction = 'BLOCK';

ReCAPTCHAKeyClientType

Loại nền tảng của khoá.

Chữ ký:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

ReCAPTCHAProvider EnforcementState

Trạng thái thực thi của biện pháp bảo vệ reCAPTCHA. – "TẮT": Không thực thi. – "AUDIT": Tạo bài đánh giá nhưng không thực thi kết quả. – "ENFORCE": Tạo bài đánh giá và thực thi kết quả.

Chữ ký:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

SmsRegionConfig

Giao diện yêu cầu cập nhật Cấu hình khu vực qua SMS. Định cấu hình những khu vực nơi người dùng được phép gửi tin nhắn SMS xác minh. Thông tin này dựa trên mã gọi của số điện thoại đích.

Chữ ký:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Chữ ký:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

Loại biểu thị các thuộc tính của một yếu tố thứ hai đã được người dùng đăng ký cho một UpdateRequest.

Chữ ký:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Giá trị nhận dạng người dùng

Xác định người dùng cần tra cứu.

Chữ ký:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;