TenantAwareAuth class

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 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 người thuê cụ thể.

Chế độ hỗ trợ nhiều khách hàng thuê 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 chứa 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 cho những người dùng đã đăng nhập vào một đối tượng thuê cụ thể, đồng thời có thể tạo đường liên kết hành động qua email cho người dùng của người 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().

Chữ ký:

export declare class TenantAwareAuth extends BaseAuth

Mở rộng: BaseAuth

Thuộc tính

Tài sản Công cụ sửa đổi Loại Mô tả
tenantId chuỗi Giá trị nhận dạng đối tượng thuê tương ứng với thực thể TenantAwareAuth này. Tất cả các lệnh gọi đến API quản lý người dùng, API quản lý nhà cung cấp OIDC/SAML, API tạo đường liên kết qua email, v.v. sẽ chỉ được áp dụng trong phạm vi của đối tượng thuê này.

Phương thức

Phương thức Công cụ sửa đổi Mô tả
createSessionCookie(idToken, sessionCookieOptions) 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 xác nhận quyền sở hữu tải trọng giống như mã thông báo mã nhận dạng được cung cấp.Hãy xem phần Quản lý cookie phiên để biết mã mẫu và tài liệu chi tiết.
verifyIdToken(idToken, checkRemovedd) 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, lời hứa sẽ bị từ chối.Nếu bạn đặt checkRevoked thành true thì 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ệ, hệ thống sẽ gửi thông báo lỗi auth/id-token-revoked. Nếu không được chỉ định, quy trình 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 các mã mẫu và tài liệu chi tiết.
verifySessionCookie(sessionCookie, checkRemovedd) 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 checkRevoked được đặt thành true thì 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ó, 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, việc kiểm tra sẽ không được thực hiện.Xem Xác minh cookie phiên để biết mã mẫu và tài liệu chi tiết

TenantAwareAuth.tenantId

Giá trị nhận dạng đối tượng thuê tương ứng với thực thể TenantAwareAuth này. Tất cả các lệnh gọi đến API quản lý người dùng, API quản lý nhà cung cấp dịch vụ OIDC/SAML, API tạo đường liên kết qua email, v.v. sẽ chỉ được áp dụng trong phạm vi của đối tượng thuê này.

Chữ ký:

readonly tenantId: string;

TenantAwareAuth.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ố

Thông số Loại Mô tả
mã thông báo id chuỗi Mã thông báo mã Firebase để đổi lấy một cookie của phiên.
sessionCookieOptions SessionCookieOptions Tùy chọn cookie phiên bao gồm thời lượng phiên tùy chỉnh.

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.

TenantAwareAuth.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ệ, 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ố

Thông số Loại Mô tả
mã thông báo id chuỗi Mã thông báo mã nhận dạng cần xác minh.
Đã thu hồi séc boolean Liệu có cần kiểm tra xem mã thông báo giá trị nhận dạng có bị thu hồi hay không. Điều này đòi hỏi bạn phải gửi thêm một 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, bước kiểm tra bổ sung này sẽ không áp dụng.

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

Hứa<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.

TenantAwareAuth.verifySessionCookie()

Xác minh cookie của phiên Firebase. Trả về Lời hứa kèm theo 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ệ, 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ố

Thông số Loại Mô tả
cookie 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:

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.