Tenant class

Đại diện cho một cấu hình đối tượng thuê.

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.

Trước khi có thể sử dụng nhiều đối tượng thuê trong một dự án Google Cloud Identity Platform, người thuê phải được cho phép trong 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 các thông tin như tên hiển thị, giá trị nhận dạng đối tượng thuê và cấu hình xác thực email. Để quản lý cấu hình của nhà cung cấp dịch vụ OIDC/SAML, bạn nên sử dụng các thực thể TenantAwareAuth thay vì Tenant để truy xuất danh sách các IdP đã định cấu hình trên một đối tượng thuê. Khi định cấu hình các nhà cung cấp này, xin lưu ý rằng người thuê sẽ kế thừa các miền có trong danh sách cho phép và URI chuyển hướng đã xác thực của dự án mẹ.

Mọi chế độ cài đặt khác của một đối tượng thuê cũng sẽ được kế thừa. Bạn cần quản lý các thông tin này từ giao diện người dùng Cloud Console.

Chữ ký:

export declare class Tenant 

Thuộc tính

Tài sản Công cụ sửa đổi Loại Mô tả
anonymousSignInEnabled boolean
displayName chuỗi Tên hiển thị của đối tượng thuê.
emailPrivacyConfig EmailPrivacyConfig Cấu hình quyền riêng tư trong email dành cho người thuê
emailSignInConfig EmailSignInProviderConfig | chưa xác định Cấu hình của nhà cung cấp dịch vụ đăng nhập qua email.
multiFactorConfig MultiFactorConfig | chưa xác định Cấu hình xác thực đa yếu tố đối với đối tượng thuê hiện tại.
passwordPolicyConfig PasswordPolicyConfig Cấu hình chính sách mật khẩu dành cho đối tượng thuê
reCAPTCHAConfig RecaptchaConfig | chưa 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 qua SMS để cập nhật đối tượng thuê. Định cấu hình những khu vực nơi người dùng được phép gửi tin nhắn SMS xác minh. Thông tin này dựa trên mã gọi của số điện thoại đích.
tenantId chuỗi Mã nhận dạng đối tượng thuê.
testPhoneNumbers { [phoneNumber: string]: string; } Bản đồ chứa số điện thoại thử nghiệm / cặp mã của đối tượng thuê.

Phương thức

Phương thức Công cụ sửa đổi Mô tả
toJSON() Trả về một bản trình bày có thể chuyển đổi tuần tự JSON của đối tượng này.

Tenant.anonymousSignInEnabled

Chữ ký:

readonly anonymousSignInEnabled: boolean;

Tenant.displayName

Tên hiển thị của đối tượng thuê.

Chữ ký:

readonly displayName?: string;

Tenant.emailPrivacyConfig

Cấu hình quyền riêng tư trong email dành cho người thuê

Chữ ký:

readonly emailPrivacyConfig?: EmailPrivacyConfig;

Tenant.emailSignInConfig

Cấu hình của nhà cung cấp dịch vụ đăng nhập qua email.

Chữ ký:

get emailSignInConfig(): EmailSignInProviderConfig | undefined;

Tenant.multiFactorConfig

Cấu hình xác thực đa yếu tố đối với đố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 dành cho đối tượng 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 qua SMS để cập nhật đối tượng thuê. Định cấu hình những khu vực nơi người dùng được phép gửi tin nhắn SMS xác minh. Thông tin này dựa trên mã gọi của số điện thoại đích.

Chữ ký:

readonly smsRegionConfig?: SmsRegionConfig;

Mã tenant.tenant

Mã nhận dạng đối tượng thuê.

Chữ ký:

readonly tenantId: string;

Tenant.testPhoneNumbers

Bản đồ chứa số điện thoại thử nghiệm / cặp mã của đối tượng thuê.

Chữ ký:

readonly testPhoneNumbers?: {
        [phoneNumber: string]: string;
    };

Tenant.toJSON()

Trả về một bản trình bày có thể chuyển đổi tuần tự JSON của đối tượng này.

Chữ ký:

toJSON(): object;

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

đối tượng

Một bản trình bày có thể chuyển đổi tuần tự JSON của đối tượng này.