BaseAuth class

Giao diện chính chung cho cả API Auth và TenantAwareAuth .

Chữ ký:

export declare abstract class BaseAuth 

phương pháp

BaseAuth.createCustomToken()

Tạo mã thông báo tùy chỉnh Firebase (JWT) mới có thể được gửi trở lại thiết bị khách để sử dụng nhằm đăng nhập bằng phương thức signInWithCustomToken() của SDK khách. (Các phiên bản nhận biết đối tượng thuê cũng sẽ nhúng ID đối tượng thuê vào mã thông báo.)

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

Chữ ký:

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

Thông số

Trả về:

Hứa<string>

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

BaseAuth.createProviderConfig()

Trả về lời hứa được giải quyết bằng AuthProviderConfig mới được tạo khi cấu hình nhà cung cấp mới được tạo.

Hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm giá cả và tính năng, hãy xem tài liệu GCIP .

Chữ ký:

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

Thông số

Trả về:

Lời hứa< AuthProviderConfig >

Một lời hứa được giải quyết bằng cấu hình nhà cung cấp đã tạo.

BaseAuth.createSessionCookie()

Tạo cookie phiên Firebase mới với các tùy chọn được chỉ định. Chuỗi JWT đã tạo có thể được đặt làm cookie phiên phía máy chủ với chính sách cookie tùy chỉnh và được sử dụng để quản lý phiên. Cookie phiên JWT sẽ có cùng yêu cầ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ẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Hứa<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 một người dùng mới.

Xem Tạo người dùng để lấy mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Bản ghi người dùng >

Lời hứa được thực hiện với dữ liệu người dùng tương ứng với người dùng mới được tạo.

BaseAuth.deleteProviderConfig()

Xóa cấu hình nhà cung cấp tương ứng với ID nhà cung cấp đã được thông qua. Nếu ID được chỉ định không tồn tại, lỗi auth/configuration-not-found sẽ xuất hiện.

Hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm giá cả và tính năng, hãy xem tài liệu GCIP .

Chữ ký:

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

Thông số

Trả về:

Hứa<void>

Một lời hứa sẽ được giải quyết khi hoàn thành.

BaseAuth.deleteUser()

Xóa một người dùng hiện có.

Xem Xóa người dùng để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Hứa<void>

Một lời hứa trống được thực hiện sau khi người dùng bị xóa.

BaseAuth.deleteUsers()

Xóa người dùng được chỉ định bởi uids đã cho.

Việc xóa người dùng không tồn tại sẽ không tạo ra lỗi (tức là phương pháp này không có tác dụng.) Người dùng không tồn tại được coi là đã xóa thành công và do đó được tính vào giá trị DeleteUsersResult.successCount .

Chỉ có thể cung cấp tối đa 1000 số nhận dạng. Nếu hơn 1000 số nhận dạng được cung cấp, phương thức này sẽ đưa ra FirebaseAuthError.

API này hiện bị giới hạn tốc độ tại máy chủ ở mức 1 QPS. Nếu bạn vượt quá mức này, bạn có thể gặp lỗi vượt quá hạn ngạch. Do đó, nếu muốn xóa hơn 1000 người dùng, bạn có thể cần thêm độ 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ả về:

Lời hứa< XóaNgười dùngKết quả >

Một Lời hứa giải quyết tổng số lần xóa thành công/thất bại, cũng như dãy lỗi tương ứng với các lần xóa không thành công.

BaseAuth.generateEmailVerificationLink()

Tạo liên kết hành động email ngoài nhóm để 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 liệu liên kết có được xử lý bởi ứng dụng di động hoặc trình duyệt hay không cùng với thông tin trạng thái bổ sung sẽ được chuyển trong liên kết sâu, v.v.

Chữ ký:

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

Thông số

Trả về:

Hứa<string>

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

Chữ ký:

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

Thông số

Trả về:

Hứa<string>

Một lời hứa được giải quyết bằ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 liên kết hành động email ngoài nhóm để 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 liệu liên kết có được xử lý bởi ứng dụng di động hoặc trình duyệt hay không cùng với thông tin trạng thái bổ sung sẽ được chuyển trong liên kết sâu, v.v.

Chữ ký:

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

Thông số

Trả về:

Hứa<string>

Một lời hứa được giải quyết bằ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 liên kết hành động 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 liệu liên kết có được xử lý bởi ứng dụng di động hoặc trình duyệt hay không cùng với thông tin trạng thái bổ sung sẽ được chuyển trong liên kết sâu, v.v.

Chữ ký:

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

Thông số

Trả về:

Hứa<string>

Một lời hứa được giải quyết bằng liên kết được tạo.

BaseAuth.getProviderConfig()

Tra cứu cấu hình nhà cung cấp Auth theo ID được cung cấp. Trả về lời hứa được giải quyết bằng cấu hình nhà cung cấp tương ứng với ID nhà cung cấp được chỉ định. Nếu ID được chỉ định không tồn tại, lỗi auth/configuration-not-found sẽ xuất hiện.

Hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm giá cả và tính năng, hãy xem tài liệu GCIP .

Chữ ký:

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

Thông số

Trả về:

Lời hứa< AuthProviderConfig >

Lời hứa được giải quyết bằng cấu hình tương ứng với ID được cung cấp.

BaseAuth.getUser()

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

Xem Truy xuất dữ liệu người dùng để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Bản ghi người dùng >

Lời hứa được thực hiện với 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 cho người dùng tương ứng với một email nhất định.

Xem Truy xuất dữ liệu người dùng để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Bản ghi người dùng >

Lời hứa được thực hiện với 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 nhất định. Số điện thoại phải tuân theo thông số kỹ thuật E.164.

Xem Truy xuất dữ liệu người dùng để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Bản ghi người dùng >

Lời hứa được thực hiện với dữ liệu người dùng tương ứng với số điện thoại được cung cấp.

BaseAuth.getUserByProviderUid()

Nhận dữ liệu người dùng cho người dùng tương ứng với id nhà cung cấp nhất định.

Xem Truy xuất dữ liệu người dùng để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Bản ghi người dùng >

Một lời hứa được thực hiện với dữ liệu người dùng tương ứng với id 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 mã định danh được chỉ định.

Không có đảm bảo đặt hàng; cụ thể, 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.

Chỉ có thể cung cấp tối đa 100 mã định danh. Nếu cung cấp hơn 100 mã định danh thì phương thức này sẽ đưa ra FirebaseAuthError.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< GetUsersResult >

Một lời hứa sẽ giải quyết các hồ sơ người dùng tương ứng.

Ngoại lệ

FirebaseAuthError Nếu bất kỳ số nhận dạng nào không hợp lệ hoặc nếu có hơn 100 số 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. Tối đa 1000 người dùng được phép nhập cùng một lúc. Khi nhập người dùng bằng mật khẩu, UserImportOptions phải được chỉ định. Hoạt động này được tối ưu hóa cho việc nhập số lượng lớn và sẽ bỏ qua việc kiểm tra uid , email và tính duy nhất của mã định danh khác có thể dẫn đến trùng lặp.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Người dùng Nhập kết quả >

Một lời hứa sẽ được giải quyết khi thao tác hoàn tất với kết quả của quá trình nhập. Điề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 của chúng.

BaseAuth.listProviderConfigs()

Trả về danh sách cấu hình nhà cung cấp hiện có phù hợp với bộ lọc được cung cấp. Tối đa 100 cấu hình nhà cung cấp có thể được liệt kê cùng một lúc.

Hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm giá cả và tính năng, hãy xem tài liệu GCIP .

Chữ ký:

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

Thông số

Trả về:

Lời hứa< ListProviderConfigResults >

Lời hứa được giải quyết bằng danh sách cấu hình 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 đợt) với kích thước maxResults bắt đầu từ phần bù như được chỉ định bởi pageToken . Điều này được sử dụng để truy xuất tất cả người dùng của một dự án được chỉ định theo đợt.

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

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Danh sách người dùngKết quả >

Lời hứa được thực hiện 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ả các mã thông báo làm mới cho người dùng hiện tại.

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

Mặc dù điều này sẽ thu hồi tất cả các phiên đối với một người dùng được chỉ định và vô hiệu hóa 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 mã thông báo ID hiện tại 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 ID đã 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ả về:

Hứa<void>

Một 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 các xác nhận quyền sở hữu bổ sung của nhà phát triển đối với người dùng hiện tại được xác định bởi uid được cung cấp , thường được sử dụng để xác định vai trò của người dùng và cấp độ truy cập. Những xác nhận quyền sở hữu này sẽ được truyền tới tất cả các 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 đăng nhập tiếp theo của người dùng. Nếu tên xác nhận quyền sở hữu OIDC dành riêng được sử dụng (phụ, iat, iss, v.v. ), một lỗi được đưa ra. Chúng được đặt trên mã thông báo ID người dùng được xác thực JWT.

Xem Xác định vai trò người dùng và cấp độ truy cập cho các mẫu mã và tài liệu chi tiết.

Chữ ký:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

Thông số

Trả về:

Hứa<void>

Một lời hứa sẽ được giải quyết khi thao tác hoàn tất thành công.

BaseAuth.updateProviderConfig()

Trả về lời hứa được giải quyết bằng AuthProviderConfig được cập nhật tương ứng với ID nhà cung cấp được chỉ định. Nếu ID được chỉ định không tồn tại, lỗi auth/configuration-not-found sẽ xuất hiện.

Hỗ trợ của nhà cung cấp SAML và OIDC yêu cầu Nền tảng nhận dạng (GCIP) của Google Cloud. Để tìm hiểu thêm về GCIP, bao gồm giá cả và tính năng, hãy xem tài liệu GCIP .

Chữ ký:

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

Thông số

Trả về:

Lời hứa< AuthProviderConfig >

Một lời hứa sẽ được giải quyết bằng cấu hình nhà cung cấp được cập nhật.

BaseAuth.updateUser()

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

Xem Cập nhật người dùng để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Bản ghi người dùng >

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 ID Firebase (JWT). Nếu mã thông báo hợp lệ, lời hứa sẽ được thực hiện với các xác nhận quyền sở hữu đã được 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 true, trước tiên hãy xác minh xem người dùng tương ứng có bị vô hiệu hóa hay không. Nếu có, lỗi auth/user-disabled sẽ được đưa ra. Nếu không, hãy xác minh xem phiên tương ứng với mã thông báo ID có bị thu hồi hay không. Nếu phiên của người dùng tương ứng bị vô hiệu, lỗi auth/id-token-revoked sẽ được đưa ra. Nếu không được chỉ định thì việc kiểm tra sẽ không được áp dụng.

Xem Xác minh mã thông báo ID để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Đã giải mãIdToken >

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 mã thông báo nếu mã thông báo ID hợp lệ; nếu không, một lời hứa bị từ chối.

BaseAuth.verifySessionCookie()

Xác minh cookie phiên Firebase. Trả về một Lời hứa với các xác nhận quyền sở hữu cookie. Từ chối lời hứa nếu cookie không thể được xác minh.

Nếu checkRevoked được đặt 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 hóa hay không: Nếu có, lỗi auth/user-disabled sẽ được đưa ra. Nếu không, hãy xác minh xem phiên tương ứng với cookie phiên có bị thu hồi hay không. Nếu phiên của người dùng tương ứng bị vô hiệu, lỗi auth/session-cookie-revoked sẽ được đưa ra. Nếu không được chỉ định thì việc kiểm tra sẽ không được thực hiện.

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

Chữ ký:

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

Thông số

Trả về:

Lời hứa< Đã giải mãIdToken >

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, một lời hứa bị từ chối.