Tenant class

แสดงการกำหนดค่ากลุ่มผู้ใช้

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

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

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

ระบบจะรับค่าการตั้งค่าอื่นๆ ทั้งหมดของกลุ่มผู้ใช้ด้วย ซึ่งจะต้องจัดการจาก UI ของ Cloud Console

ลายเซ็น:

export declare class Tenant 

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ คีย์ตัวปรับแต่ง ประเภท คำอธิบาย
anonymousSignInEnabled boolean
ชื่อการแสดงผล สตริง ชื่อที่แสดงของกลุ่มผู้ใช้
emailPrivacyConfig EmailPrivacyConfig การกำหนดค่าความเป็นส่วนตัวของอีเมลสำหรับกลุ่มผู้ใช้
emailSignInConfig EmailSignInProviderConfig | ไม่ได้กำหนด การกำหนดค่าผู้ให้บริการการลงชื่อเข้าใช้อีเมล
multiFactorConfig MultiFactorConfig | ไม่ได้กำหนด การกำหนดค่าการตรวจสอบสิทธิ์แบบหลายปัจจัยในกลุ่มผู้ใช้ปัจจุบัน
passwordPolicyConfig PasswordPolicyConfig การกำหนดค่านโยบายรหัสผ่านสำหรับกลุ่มผู้ใช้
recaptchaConfig RecaptchaConfig | ไม่ได้กำหนด การกำหนดค่าการตรวจสอบสิทธิ์การกำหนดค่า reCAPTCHA ของกลุ่มผู้ใช้ปัจจุบัน
smsRegionConfig SmsRegionConfig การกำหนดค่าภูมิภาคของ SMS เพื่ออัปเดตกลุ่มผู้ใช้ กำหนดค่าภูมิภาคที่ผู้ใช้ได้รับอนุญาตให้ส่ง SMS ยืนยัน โดยอิงจากรหัสการโทรของหมายเลขโทรศัพท์ปลายทาง
รหัสกลุ่มผู้ใช้ สตริง ตัวระบุกลุ่มผู้ใช้
testPhoneNumbers { [หมายเลขโทรศัพท์: สตริง]: สตริง; } แผนที่ที่มีคู่หมายเลขโทรศัพท์ / รหัสทดสอบสำหรับกลุ่มผู้ใช้

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
toJSON() แสดงผลการนำเสนอ JSON แบบอนุกรมของออบเจ็กต์นี้

Tenant.anonymousSignInEnabled

ลายเซ็น:

readonly anonymousSignInEnabled: boolean;

Tenant.displayName

ชื่อที่แสดงของกลุ่มผู้ใช้

ลายเซ็น:

readonly displayName?: string;

Tenant.emailPrivacyConfig

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

ลายเซ็น:

readonly emailPrivacyConfig?: EmailPrivacyConfig;

Tenant.emailSignInConfig

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

ลายเซ็น:

get emailSignInConfig(): EmailSignInProviderConfig | undefined;

Tenant.multiFactorConfig

การกำหนดค่าการตรวจสอบสิทธิ์แบบหลายปัจจัยในกลุ่มผู้ใช้ปัจจุบัน

ลายเซ็น:

get multiFactorConfig(): MultiFactorConfig | undefined;

Tenant.passwordPolicyConfig

การกำหนดค่านโยบายรหัสผ่านสำหรับกลุ่มผู้ใช้

ลายเซ็น:

readonly passwordPolicyConfig?: PasswordPolicyConfig;

Tenant.recaptchaConfig

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

ลายเซ็น:

get recaptchaConfig(): RecaptchaConfig | undefined;

Tenant.smsRegionConfig

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

ลายเซ็น:

readonly smsRegionConfig?: SmsRegionConfig;

Tenant.tenantId

ตัวระบุกลุ่มผู้ใช้

ลายเซ็น:

readonly tenantId: string;

Tenant.testPhoneNumbers

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

ลายเซ็น:

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

Tenant.toJSON()

แสดงผลการนำเสนอ JSON แบบอนุกรมของออบเจ็กต์นี้

ลายเซ็น:

toJSON(): object;

การคืนสินค้า:

ออบเจ็กต์

การนำเสนอที่ซีเรียลได้ของ JSON ของออบเจ็กต์นี้