Giao diện Auth nhận biết đối tượng thuê được sử dụng để quản lý người dùng, định cấu hình nhà cung cấp SAML/OIDC, tạo liên kết email để đặt lại mật khẩu, xác minh email, v.v. cho những đối tượng thuê cụ thể.
Hỗ trợ nhiều bên thuê 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 .
Mỗi đối tượng thuê chứa các nhà cung cấp danh tính, cài đặt và nhóm người dùng riêng. Sử dụng TenantAwareAuth , người dùng cho một đối tượng thuê cụ thể và các cấu hình OIDC/SAML tương ứng cũng có thể được quản lý, mã thông báo ID cho người dùng đã đăng nhập vào một đối tượng thuê cụ thể cũng có thể được xác minh và cũng có thể tạo liên kết hành động qua email cho người dùng thuộc đối tượng thuê.
Có thể khởi tạo các phiên bản 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
Của cải
| Tài sản | sửa đổi | Kiểu | Sự miêu tả |
|---|---|---|---|
| id người thuê nhà | sợi dây | Mã định danh đối tượng thuê tương ứng với phiên bản TenantAwareAuth này. Tất 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 liên kết email, v.v. sẽ chỉ được áp dụng trong phạm vi của đối tượng thuê này. |
phương pháp
| Phương pháp | sửa đổi | Sự miêu tả |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) | 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. | |
| verifyIdToken(idToken, checkRevoked) | 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. | |
| verifySessionCookie(sessionCookie, checkRevoked) | 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 |
TenantAwareAuth.tenantId
Mã định danh đối tượng thuê tương ứng với phiên bản TenantAwareAuth này. Tất 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 liên kết 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 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ố
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| idToken | sợi dây | Mã thông báo ID Firebase để đổi lấy cookie phiên. |
| phiênCookieTùy chọn | PhiênCookieTùy chọn | Các tùy chọn cookie phiên bao gồm thời lượng phiên tùy chỉnh. |
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.
TenantAwareAuth.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ố
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| idToken | sợi dây | Mã thông báo ID để xác minh. |
| kiểm traĐã thu hồi | boolean | Có kiểm tra xem mã thông báo ID có bị thu hồi hay không. Điều này yêu cầu một yêu cầu bổ sung tới phần phụ trợ Firebase Auth để kiểm tra thời gian tokensValidAfterTime cho người dùng tương ứng. Khi không được chỉ định, kiểm tra bổ sung này sẽ không được áp dụng. |
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.
TenantAwareAuth.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ố
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| phiênCookie | sợi dây | Cookie phiên để xác minh. |
| kiểm traĐã thu hồi | boolean |
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.