BaseAuth class

Giao diện mẹ phổ biến cho cả API Auth và TenantAwareAuth.

Chữ ký:

export declare abstract class BaseAuth 

Phương thức

BaseAuth.createCustomToken()

Tạo mã thông báo tuỳ chỉnh Firebase (JWT) mới có thể được gửi lại thiết bị khách để dùng cho việc đăng nhập bằng SDK ứng dụng khách signInWithCustomToken() phương thức. (Các thực thể nhận biết được người thuê cũng sẽ nhúng mã đối tượng thuê vào mã thông báo.)

Xem phần Tạo mã thông báo tuỳ chỉnh để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

Thông số

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

Cam kết<string>

Đã thực hiện lời hứa bằng một mã thông báo tuỳ chỉnh cho uid và tải trọng được cung cấp.

BaseAuth.createProviderConfig()

Trả về lời hứa phân giải bằng AuthProviderConfig mới tạo khi tạo cấu hình trình cung cấp mới.

Dịch vụ hỗ trợ nhà cung cấp SAML và OIDC đòi hỏi 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.

Chữ ký:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

Thông số

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

Cam kết<AuthProviderConfig>

Lời hứa sẽ được giải quyết với cấu hình của nhà cung cấp đã tạo.

BaseAuth.createSessionCookie()

Tạo một cookie phiên mới trên Firebase với các lựa chọn được chỉ định. Chuỗi JWT đã tạo có thể được đặt làm cookie phiên phía máy chủ bằng chính sách cookie tuỳ chỉnh và được dùng để quản lý phiên. Cookie phiên JWT sẽ có các thông báo xác nhận quyền sở hữu tải trọng giố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 để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

Thông số

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

Cam kết<string>

Lời hứa sẽ giải quyết thành công với cookie phiên đã tạo.

BaseAuth.createUser()

Tạo người dùng mới.

Hãy xem phần Tạo người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

createUser(properties: CreateRequest): Promise<UserRecord>;

Thông số

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 được truyền. Nếu mã nhận dạng được chỉ định không tồn tại, hệ thống sẽ gửi lỗi auth/configuration-not-found.

Dịch vụ hỗ trợ nhà cung cấp SAML và OIDC đòi hỏi 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.

Chữ ký:

deleteProviderConfig(providerId: string): Promise<void>;

Thông số

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

Lời hứa<vô hiệu>

Lời hứa sẽ thực hiện khi hoàn thành.

BaseAuth.deleteUser()

Xoá người dùng hiện có.

Hãy xem phần Xoá người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

deleteUser(uid: string): Promise<void>;

Thông số

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

Lời hứa<vô hiệu>

Lời hứa không có nội dung được thực hiện sau khi người dùng bị xoá.

BaseAuth.deleteUsers()

Xoá người dùng được chỉ định bởi các uid đã cho.

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 không tồn tại sẽ được coi là đã xoá thành công và do đó đượ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 thông báo lỗi FirebaseAuthError.

API này hiện bị giới hạn tốc độ tại 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 khoảng thời gian trễ để đảm bảo không vượt quá giới hạn này.

Chữ ký:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

Thông số

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

Hứa hẹn<DeleteUsersResult>

Lời hứa sẽ phân giải tổng số lần xoá thành công/không thành công, cũng như một loạt các lỗi tương ứng với những lần xoá không thành công.

BaseAuth.generateEmailVerifyLink()

Tạo đường liên kết hành động qua email ngoài phạm vi để xác minh quyền sở hữu của người dùng đối với email được chỉ định. Đối tượng ActionCodeSettings được cung cấp làm đối số cho phương thức này xác định xem đường liên kết có được xử lý bởi một ứng dụng hoặc trình duyệt cho thiết bị di động cùng với thông tin bổ sung về trạng thái được truyền vào đường liên kết sâu hay không, v.v.

Chữ ký:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Thông số

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

Cam kết<string>

Lời hứa sẽ phân giải bằng đường liên kết được 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 hành động qua email bên ngoài nhóm để đặ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 được chỉ định. Đối tượng không bắt buộc ActionCodeSettings xác định xem đường liên kết sẽ được xử lý bởi ứng dụng hoặc trình duyệt dành cho thiết bị di động hay không, cũng như 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ố

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

Cam kết<string>

Lời hứa sẽ phân giải bằng đường liên kết được 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 hành động qua email ngoài phạm vi để xác minh quyền sở hữu của người dùng đối với email được chỉ định. Đối tượng ActionCodeSettings được cung cấp làm đối số cho phương thức này xác định xem đường liên kết có được xử lý bởi một ứng dụng hoặc trình duyệt cho thiết bị di động cùng với thông tin bổ sung về trạng thái được truyền vào đường liên kết sâu hay không, v.v.

Chữ ký:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

Thông số

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

Cam kết<string>

Lời hứa sẽ phân giải bằng đường liên kết được 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 hành động qua email ngoài băng tần để xác minh quyền sở hữu của người dùng đối với email được chỉ định. Đối tượng ActionCodeSettings được cung cấp làm đối số cho phương thức này xác định xem đường liên kết có được xử lý bởi một ứng dụng hoặc trình duyệt cho thiết bị di động cùng với thông tin bổ sung về trạng thái được truyền vào đườ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ố

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

Cam kết<string>

Lời hứa sẽ phân giải bằng đường liên kết được 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 phân giải theo 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 lỗi auth/configuration-not-found.

Dịch vụ hỗ trợ nhà cung cấp SAML và OIDC đòi hỏi 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.

Chữ ký:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

Thông số

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

Cam kết<AuthProviderConfig>

Lời hứa được phân giải với 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 của người dùng tương ứng với một uid cụ thể.

Hãy xem phần Truy xuất dữ liệu người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

getUser(uid: string): Promise<UserRecord>;

Thông số

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 được cung cấp.

BaseAuth.getUserByEmail()

Lấy dữ liệu người dùng tương ứng với một email cụ thể.

Hãy xem phần Truy xuất dữ liệu người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

getUserByEmail(email: string): Promise<UserRecord>;

Thông số

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 được 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 cụ thể. Số điện thoại phải tuân thủ thông số kỹ thuật E.164.

Hãy xem phần Truy xuất dữ liệu người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

Thông số

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 được cung cấp.

BaseAuth.getUserByProviderUid()

Lấy dữ liệu người dùng cho người dùng tương ứng với một mã nhà cung cấp nhất định.

Hãy xem phần Truy xuất dữ liệu người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

Thông số

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 cụ thể.

BaseAuth.getUsers()

Lấy dữ liệu người dùng tương ứng với giá trị nhận dạng đã chỉ định.

Không có gì đảm bảo cho việc đặt hàng; 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ó 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 thông báo lỗi FirebaseAuthError.

Chữ ký:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

Thông số

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

Hứa hẹn<GetUsersResult>

Lời hứa phân giải thành 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 bạn chỉ định nhiều hơn 100 giá trị nhận dạng.

BaseAuth.nhậpUsers()

Nhập danh sách người dùng được cung cấp vào tính năng Xác thực Firebase. Mỗi lần, bạn chỉ được phép nhập tối đa 1.000 người dùng. 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á để 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 riêng biệt khác có thể dẫn đến trùng lặp.

Chữ ký:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

Thông số

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

Hứa hẹn<UserImportResult>

Lời hứa sẽ phân giải khi hoạt động hoàn tất với kết quả nhập. Số 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à các lỗi tương ứng.

BaseAuth.listProviderConfigs()

Trả về danh sách cấu hình hiện có của nhà cung cấp khớp với bộ lọc đượ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.

Dịch vụ hỗ trợ nhà cung cấp SAML và OIDC đòi hỏi 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.

Chữ ký:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

Thông số

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

Hứa hẹn<ListProviderConfigOutcome>

Lời hứa sẽ phân giải với 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ừ giá trị bù trừ do pageToken chỉ định. Lệnh 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ụ thể.

Hãy xem phần Liệt kê tất cả người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

Thông số

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

Hứa hẹn<ListUsersResult>

Lời hứa sẽ được giải quyết với nhóm người dùng đã tải xuống hiện tại 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 một người dùng hiện có.

API này sẽ cập nhật UserRecord.tokensValidSauTime của người dùng theo giờ UTC hiện tại. Điều quan trọng là máy chủ nhận lệnh gọi này phải đặt đồng hồ chính xác và được đồng bộ hoá.

Mặc dù thao tác này sẽ thu hồi tất cả phiên đối với một người dùng đã chỉ định và vô hiệu hoá mọi mã thông báo mã nhận dạng mới cho các phiên hiện có để tránh được đúc, nhưng mã nhận dạng hiện có có thể vẫn hoạt động cho đến khi hết hạn tự nhiên (1 giờ). Để xác minh rằng mã thông báo mã nhận dạng đã bị thu hồi, hãy sử dụng BaseAuth.verifyIdToken(), trong đó checkRevoked được đặt thành true.

Chữ ký:

revokeRefreshTokens(uid: string): Promise<void>;

Thông số

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

Lời hứa<vô hiệu>

Lời hứa trống đã được thực hiện sau khi thu hồi mã làm mới của người dùng.

BaseAuth.setCustomUser claims()

Đặ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 theo uid được cung cấp, thường dùng để xác định vai trò và cấp truy cập của người dùng. Các thông báo xác nhận quyền sở hữu này sẽ á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 buộc phải làm mới mã thông báo) và vào lần tiếp theo người dùng đăng nhập. 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 giá trị này được đặt trên mã thông báo giá trị nhận dạng JWT của người dùng đã xác thực.

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ố

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

Lời hứa<vô hiệu>

Lời hứa sẽ được thực hiện khi thao tác hoàn tất thành công.

BaseAuth.updateProviderConfig()

Trả về một lời hứa phân giải bằng AuthProviderConfig đã cập nhật 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 lỗi auth/configuration-not-found.

Dịch vụ hỗ trợ nhà cung cấp SAML và OIDC đòi hỏi 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.

Chữ ký:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

Thông số

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

Cam kết<AuthProviderConfig>

Lời hứa sẽ giải quyết với cấu hình nhà cung cấp được cập nhật.

Phương thức BaseAuth.updateUser()

Cập nhật một người dùng hiện có.

Hãy xem phần Cập nhật người dùng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

Thông số

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

Cam kết<UserRecord>

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ệ, thì lời hứa sẽ được thực hiện bằng các thông báo xác nhận quyền sở hữu đã giải mã của mã thông báo; nếu không thì lời hứa sẽ bị từ chối.

Nếu bạn đặt checkRevoked thành true (đúng), trước tiên, hãy xác minh xem người dùng tương ứng có bị tắt hay không. Nếu có, hệ thống sẽ gửi thông báo lỗi auth/user-disabled. Nếu không, hãy xác minh xem phiên tương ứng với mã thông báo nhận dạng có bị thu hồi hay không. Nếu phiên của người dùng tương ứng không hợp lệ, thì hệ thống sẽ gửi thông báo lỗi auth/id-token-revoked. Nếu không được 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 mã nhận dạng để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Thông số

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

Cam kết<DecodedIdToken>

Lời hứa được thực hiện với các thông báo xác nhận quyền sở hữu đã giải mã của mã thông báo nếu mã nhận dạng hợp lệ; nếu không thì lời hứa bị từ chối.

BaseAuth.verifySessionCookie()

Xác minh cookie của phiên Firebase. Trả về Lời hứa 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 (đúng), thì 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ó, lỗi auth/user-disabled sẽ được gửi. Nếu không, 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 của người dùng tương ứng không hợp lệ, thì hệ thống sẽ gửi thông báo lỗi auth/session-cookie-revoked. Nếu không được chỉ định thì quá trình kiểm tra sẽ không được thực hiện.

Xem phần Xác minh cookie phiên để biết mã mẫu và tài liệu chi tiết

Chữ ký:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Thông số

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

Cam kết<DecodedIdToken>

Lời hứa được thực hiện với các xác nhận quyền sở hữu được giải mã của cookie phiên nếu cookie phiên hợp lệ; nếu không thì lời hứa bị từ chối.