Đại diện cho một cấu hình đối tượng thuê.
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 .
Trước khi có thể sử dụng nhiều đối tượng thuê trong dự án Google Cloud Identity Platform, đối tượng thuê phải được phép tham gia dự án đó thông qua giao diện người dùng Cloud Console.
Cấu hình đối tượng thuê cung cấp thông tin như tên hiển thị, mã định danh đố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, nên sử dụng phiên bản TenantAwareAuth thay vì Đối Tenant để truy xuất danh sách IdP đã định cấu hình trên đối tượng thuê. Khi định cấu hình các nhà cung cấp này, hãy lưu ý rằng đối tượng thuê sẽ kế thừa các miền thuộc danh sách trắng và URI chuyển hướng đã xác thực của dự án mẹ của họ.
Tất cả các cài đặt khác của đối tượng thuê cũng sẽ được kế thừa. Những thứ này sẽ cần được quản lý từ giao diện người dùng Cloud Console.
Chữ ký:
export declare class Tenant
Của cải
| Tài sản | sửa đổi | Kiểu | Sự miêu tả |
|---|---|---|---|
| ẩn danhĐăng nhậpĐã bật | boolean | ||
| tên hiển thị | sợi dây | Tên hiển thị của người thuê nhà. | |
| emailQuyền riêng tưConfig | EmailQuyền riêng tưCấu hình | Cấu hình quyền riêng tư email cho đối tượng thuê | |
| emailSignInConfig | EmailSignInProviderConfig | không xác định | Cấu hình nhà cung cấp dịch vụ đăng nhập email. | |
| multiFactorConfig | MultiFactorConfig | không xác định | Cấu hình xác thực đa yếu tố trên đối tượng thuê hiện tại. | |
| chính sách mật khẩuConfig | Chính sách mật khẩuConfig | Cấu hình chính sách mật khẩu cho người thuê | |
| recaptchaConfig | RecaptchaConfig | không xác định | Cấu hình xác thực cấu hình recaptcha của đối tượng thuê hiện tại. | |
| smsRegionConfig | SmsRegionConfig | Cấu hình khu vực SMS để cập nhật đối tượng thuê. Định cấu hình các khu vực nơi người dùng được phép gửi SMS xác minh. Điều này dựa trên mã gọi của số điện thoại đích. | |
| id người thuê nhà | sợi dây | Mã định danh người thuê nhà. | |
| kiểm traSố điện thoại | { [số điện thoại: chuỗi]: chuỗi; } | Bản đồ chứa cặp số/mã điện thoại thử nghiệm của người thuê. |
phương pháp
| Phương pháp | sửa đổi | Sự miêu tả |
|---|---|---|
| toJSON() | Trả về một biểu diễn có thể tuần tự hóa JSON của đối tượng này. |
Tenant.anonymousSignInEnabled
Chữ ký:
readonly anonymousSignInEnabled: boolean;
Tenant.displayName
Tên hiển thị của người thuê nhà.
Chữ ký:
readonly displayName?: string;
Tenant.emailPrivacyConfig
Cấu hình quyền riêng tư email cho đối tượng thuê
Chữ ký:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
Cấu hình nhà cung cấp dịch vụ đăng nhập email.
Chữ ký:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
Cấu hình xác thực đa yếu tố trên đối tượng thuê hiện tại.
Chữ ký:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
Cấu hình chính sách mật khẩu cho người thuê
Chữ ký:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Tenant.recaptchaConfig
Cấu hình xác thực cấu hình recaptcha của đối tượng thuê hiện tại.
Chữ ký:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
Cấu hình khu vực SMS để cập nhật đối tượng thuê. Định cấu hình các khu vực nơi người dùng được phép gửi SMS xác minh. Điều này dựa trên mã gọi của số điện thoại đích.
Chữ ký:
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
Mã định danh người thuê nhà.
Chữ ký:
readonly tenantId: string;
Tenant.testPhoneNumbers
Bản đồ chứa cặp số/mã điện thoại thử nghiệm của người thuê.
Chữ ký:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
Trả về một biểu diễn có thể tuần tự hóa JSON của đối tượng này.
Chữ ký:
toJSON(): object;
Trả về:
sự vật
Một biểu diễn có thể tuần tự hóa JSON của đối tượng này.