Tenant class

แสดงถึงการกำหนดค่าของผู้เช่า

การสนับสนุนหลายผู้เช่าต้องใช้ Identity Platform (GCIP) ของ Google Cloud หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับ GCIP รวมถึงราคาและฟีเจอร์ โปรดดู เอกสารประกอบ GCIP .

ก่อนที่จะใช้การเช่าหลายรายการบนโปรเจ็กต์ Google Cloud Identity Platform ได้ ผู้เช่าจะต้องได้รับอนุญาตในโปรเจ็กต์นั้นผ่าน UI ของ Cloud Console ก่อน

การกำหนดค่าผู้เช่าให้ข้อมูล เช่น ชื่อที่แสดง ตัวระบุผู้เช่า และการกำหนดค่าการตรวจสอบสิทธิ์อีเมล สำหรับการจัดการการกำหนดค่าผู้ให้บริการ OIDC/SAML ควรใช้อินสแตนซ์ TenantAwareAuth แทน Tenant เพื่อเรียกข้อมูลรายการ IdP ที่กำหนดค่าไว้ในผู้เช่า เมื่อกำหนดค่าผู้ให้บริการเหล่านี้ โปรดทราบว่าผู้เช่าจะสืบทอดโดเมนที่อนุญาตพิเศษและ URI การเปลี่ยนเส้นทางที่ได้รับการรับรองความถูกต้องของโปรเจ็กต์หลัก

การตั้งค่าอื่นๆ ทั้งหมดของผู้เช่าจะได้รับการสืบทอดเช่นกัน สิ่งเหล่านี้จะต้องได้รับการจัดการจาก Cloud Console UI

ลายเซ็น:

export declare class Tenant 

คุณสมบัติ

วิธีการ

ผู้เช่า.anonymousSignInEnabled

ลายเซ็น:

readonly anonymousSignInEnabled: boolean;

ผู้เช่า.displayName

ชื่อที่แสดงของผู้เช่า

ลายเซ็น:

readonly displayName?: string;

Tenant.emailPrivacyConfig

การกำหนดค่าความเป็นส่วนตัวของอีเมลสำหรับผู้เช่า

ลายเซ็น:

readonly emailPrivacyConfig?: EmailPrivacyConfig;

ผู้เช่า.emailSignInConfig

การกำหนดค่าผู้ให้บริการลงชื่อเข้าใช้อีเมล

ลายเซ็น:

get emailSignInConfig(): EmailSignInProviderConfig | undefined;

ผู้เช่า.multiFactorConfig

การกำหนดค่าการรับรองความถูกต้องแบบหลายปัจจัยในผู้เช่าปัจจุบัน

ลายเซ็น:

get multiFactorConfig(): MultiFactorConfig | undefined;

ผู้เช่า.รหัสผ่านPolicyConfig

การกำหนดค่านโยบายรหัสผ่านสำหรับผู้เช่า

ลายเซ็น:

readonly passwordPolicyConfig?: PasswordPolicyConfig;

Tenant.recaptchaConfig

การกำหนดค่าการตรวจสอบสิทธิ์ recaptcha config ของผู้เช่าปัจจุบัน

ลายเซ็น:

get recaptchaConfig(): RecaptchaConfig | undefined;

ผู้เช่า smsRegionConfig

การกำหนดค่าภูมิภาค SMS เพื่ออัปเดตผู้เช่า กำหนดค่าภูมิภาคที่ผู้ใช้ได้รับอนุญาตให้ส่ง SMS ยืนยัน ขึ้นอยู่กับรหัสโทรของหมายเลขโทรศัพท์ปลายทาง

ลายเซ็น:

readonly smsRegionConfig?: SmsRegionConfig;

Tenant.tenantId

ตัวระบุผู้เช่า

ลายเซ็น:

readonly tenantId: string;

ผู้เช่า testPhoneNumbers

แผนที่ที่มีหมายเลขโทรศัพท์ทดสอบ / คู่รหัสสำหรับผู้เช่า

ลายเซ็น:

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

ผู้เช่า.toJSON()

ส่งคืนการแสดงออบเจ็กต์ที่ทำให้เป็นอนุกรม JSON ของออบเจ็กต์นี้ได้

ลายเซ็น:

toJSON(): object;

ผลตอบแทน:

วัตถุ

การแสดงวัตถุนี้แบบอนุกรมได้ JSON