Firebase is back at Google I/O on May 14! Register now.

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ụ Auth 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ần đối số để truy cập vào dịch vụ Auth của ứng dụng mặc định hoặc dưới dạng `getAuth(app)` để truy cập vào dịch vụ Auth được liên kết với một ứng dụng cụ thể.

Hạng

Hạng	Mô tả
Xác thực	Dịch vụ xác thực liên kết với ứng dụng được cung cấp. Một thực thể Auth có thể có nhiều người thuê.
BaseAuth	Giao diện mẹ chung cho cả API `Auth` và `TenantAwareAuth`.
MultiFactorInfo (Thông tin đa yếu tố)	Giao diện biểu thị các thuộc tính chung của yếu tố thứ hai đã đăng ký của người dùng.
Chế độ cài đặt nhiều yếu tố	Chế độ cài đặt người dùng liên quan đến đa yếu tố.
PhoneMultiFactorInfo	Giao diện biểu thị yếu tố thứ hai do người dùng đăng ký trên điện thoại.
ProjectConfig	Đại diện cho cấu hình dự án.
ProjectConfigManager	Quản lý (nhận và cập nhật) cấu hình dự án hiện tại.
Người thuê	Biểu thị cấu hình của đối tượng thuê.Để hỗ trợ nhiều khách hàng, 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ả giá và các tính năng, hãy xem tài liệu về GCC.Trước khi có thể sử dụng nhiều khách hàng trong dự án Google Cloud Identity Platform, khách 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 của đối tượng thuê cung cấp những 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 nhà cung cấp OIDC/SAML, bạn nên sử dụng các phiên bản `TenantAwareAuth` thay vì `Tenant` để truy xuất danh sách IdP đã định cấu hình trên đối tượng thuê. Khi bạn định cấu hình các nhà cung cấp này, xin lưu ý rằng đối tượng 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ả 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 ứng dụng này trên giao diện người dùng của Cloud Console.
TenantAwareAuth	Giao diện `Auth` có thể nhận biết người thuê nhà được dùng để quản lý người dùng, định cấu hình nhà cung cấp SAML/OIDC, tạo đường liên kết email để đặt lại mật khẩu, xác minh email, v.v. cho những người thuê cụ thể.Để hỗ trợ nhiều khách hàng, 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à 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ác cấu hình OIDC/SAML tương ứng, xác minh mã thông báo mã nhận dạng cho 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ê đó.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ý người thuê nhà được dùng để giúp quản lý các hoạt động liên quan đến người thuê. Điều 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. Nhận thực thể `TenantAwareAuth` để chạy các hoạt động liên quan đến 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 một đố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ừ nhà cung cấp danh tính bên thứ ba, chẳng hạn như Google hoặc Facebook.
UserMetadata	Đại diện cho siêu dữ liệu của người dùng.
Bản ghi người dùng	Đại diện cho một 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 với các giá trị nhận dạng gói Android và iOS không bắt buộc.
AllowByDefault	Xác định chính sách cho phép mọi khu vực theo mặc định và thêm những 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 sử dụng SMS độc quyền chung cho giao diện AllowByDefault
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 loại trừ lẫn nhau của giao diện AllowlistOnly
AuthProviderConfigFilter	Giao diện bộ lọc dùng để lập cấu hình nhà cung cấp danh sách. Chế độ này dùng khi chỉ định cách liệt kê các nhà cung cấp danh tính đã định cấu hình thông qua BaseAuth.listProviderConfigs().
BaseAuthProviderConfig	Giao diện cấu hình nhà cung cấp dịch vụ xác thực cơ sở.
BaseCreateMultiFactorInfoRequest	Giao diện biểu thị các thuộc tính cơ sở của yếu tố thứ hai đã đăng ký của người dùng cho `CreateRequest`.
BaseUpdateMultiFactorInfoRequest	Giao diện biểu thị các thuộc tính phổ biến của yếu tố thứ hai đã đăng ký của người dùng cho một `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest	Giao diện biểu thị yếu tố thứ hai do người dùng đăng ký trên điện thoại cho một `CreateRequest`.
Tạo yêu cầu	Giao diện cho các thuộc tính cần đặt trên một bản ghi người dùng mới sẽ được tạo.
CustomStrengthOptionsConfig	Các ràng buộc cần thực thi đối với chính sách mật khẩu
DecodedAuthBlockingToken
DecodeIdToken	Giao diện biểu thị mã thông báo mã nhận dạng Firebase đã giải mã, được trả về từ phương thức BaseAuth.verifyIdToken().Mã thông báo mã nhận dạng Firebase là mã thông báo web JSON tuân thủ quy cách của OpenSL Connect. Xem [phần Mã thông báo ID trong thông số kỹ thuật của OpenSL 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.
Xoá kết quả của người dùng	Đại diện cho kết quả của API BaseAuth.deleteUsers()..
EmailIdentifier	Dùng để tra cứu tài khoản qua email.Xem BaseAuth.getUsers().
EmailPrivacyConfig	Cấu hình quyền riêng tư đối với email của một dự án hoặc đối tượng thuê.
EmailSignInProviderConfig	Cấu hình nhà cung cấp dịch vụ đăng nhập email.
GetUsersResult	Đại diện cho kết quả của API BaseAuth.getUsers().
ListProviderConfigResults	Giao diện phản hồi cho cấu hình của nhà cung cấp danh sách. Bạn chỉ có thể sử dụng tính năng này khi liệt kê tất cả cấu hình của nhà cung cấp danh tính qua BaseAuth.listProviderConfigs().
ListTenantsResult	Giao diện biểu thị đối tượng được trả về từ 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 đại diện cho cấu hình đa yếu tố. Bạn có thể sử dụng thuộc tính này để xác định xem tính năng xác thực đa yếu tố được bật hay tắt và danh sách các thử thách yếu tố 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 nhiều yếu tố cho thao tác tạo.
MultiFactorProviderConfig	Giao diện đại diện cho cấu hình nhà cung cấp dịch vụ xác thực đa yếu tố. Giao diện này được sử dụng cho nhà cung cấp dịch vụ xác thực yếu tố thứ hai ngoài SMS. Hiện tại, chỉ hỗ trợ TOTP.
MultiFactorUpdateSettings (Cài đặt đa yếu tố)	Chế độ cài đặt người dùng liên quan đến nhiều yếu tố cho hoạt động cập nhật.
OAuthResponseType	Giao diện đại diện cho đối tượng phản hồi của trình cung cấp OIDC cho quy trình uỷ quyền OAuth. Một trong các chế độ cài đặt sau là bắt buộc: Đặt `code` thành `true` cho luồng mã. Đặt `idToken` thành `true` cho quy trình của mã thông báo giá trị nhận dạng.
OIDCAuthProviderConfig	Giao diện cấu hình nhà cung cấp dịch vụ xác thực của [OIDC](https://openid.net/specs/openid-connect-core-1_0-connection.html). Bạn có thể tạo nhà cung cấp OIDC 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). Chế độ này được 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 một 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 tài khoản của nhà cung cấp 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.
Khoá Recaptcha	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 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. Chế độ này được dùng khi cập nhật cấu hình của nhà cung cấp SAML qua BaseAuth.updateProviderConfig().
SessionCookieOptions	Giao diện biểu thị các lựa chọn cookie của phiên cần thiết cho phương thức BaseAuth.createSessionCookie().
TotpMultiFactorProviderConfig	Giao diện biểu thị chế độ cài đặt cấu hình cho 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 biểu thị yếu tố thứ hai do người dùng đăng ký cho một `UpdateRequest` trên điện thoại.
UpdateProjectConfigRequest	Giao diện biểu thị các thuộc tính cần cập nhật trên cấu hình dự án đã cung cấp.
UpdateRequest	Giao diện biểu thị các thuộc tính cần cập nhật dựa trên người dùng được cung cấp.
UpdateTenantRequest	Giao diện biểu thị các cơ sở lưu trú cần cập nhật về bên 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(). Mã này dùng để cung cấp thông tin về thuật toán băm mật khẩu.
UserImportRecord	Giao diện cho biết người dùng cần nhập vào Firebase Auth thông qua phương thức BaseAuth.importUsers().
UserImportResult	Giao diện biểu thị phản hồi của phương thức BaseAuth.importUsers() để nhập hàng loạt người dùng vào phương thức Xác thực Firebase.
UserMetadataRequest	Siêu dữ liệu về người dùng cần đưa vào khi nhập người dùng.
UserProvider	Đại diện cho nhà cung cấp danh tính người dùng có thể liên kết với người dùng Firebase.
UserProviderRequest	Dữ liệu về nhà cung cấp người dùng cần đưa vào khi nhập người dùng.

Loại bí danh

Loại bí danh	Mô tả
AuthfactorType	Xác định loại yếu tố thứ hai.
AuthProviderConfig	Loại cấu hình Nhà cung cấp dịch vụ xác thực. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest	Loại đại diện cho các thuộc tính của yếu tố thứ hai đã đăng ký của người dùng cho `CreateRequest`.
CreateTenantRequest	Giao diện biểu thị các cơ sở lưu trú cần đặt để thuê một đối tượng thuê mới.
Loại thuật toán băm
MultiFactorConfigState	Xác định trạng thái cấu hình đa yếu tố.
PasswordPolicyPolicymentState	Trạng thái thực thi của chính sách mật khẩu.
RecaptchaAction	Các thao tác 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á.
RecaptchaProviderExecutionmentState	Trạng thái thực thi của biện pháp bảo vệ bằng reCAPTCHA. - 'TẮT': Không thi hành. – "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. Thiết lập các khu vực cho phép người dùng gửi tin nhắn SMS xác minh. Mã này dựa trên mã gọi của số điện thoại đích.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	Loại đại diện cho các thuộc tính của yếu tố thứ hai đã đăng ký của người dùng cho một `UpdateRequest`.
UserIdentifier (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)

Lấy dịch vụ Auth cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi getAuth() mà không có đối số để truy cập vào dịch vụ Auth của ứng dụng mặc định hoặc dưới dạng getAuth(app) để truy cập vào dịch vụ Auth đượ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);

Loại hệ số 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 Nhà cung cấp dịch vụ xác thực. BaseAuth.createProviderConfig().

Chữ ký:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

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

Chữ ký:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

Giao diện biểu thị các cơ sở lưu trú cần đặt để thuê một đối tượng thuê mới.

Chữ ký:

export type CreateTenantRequest = UpdateTenantRequest;

Loại thuật toán hàm 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';

MultiFactorConfigState

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

Các thao tác 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';

RecaptchaProviderEnforcementState

Trạng thái thực thi của biện pháp bảo vệ bằng reCAPTCHA. - 'TẮT': Không thi hành. – "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. Thiết lập các khu vực cho phép người dùng gửi tin nhắn SMS xác minh. Mã 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;

Cập nhật MultiFactorInfoRequest

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

Chữ ký:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

UserIdentifier

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

Chữ ký:

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