מייצג תצורת דייר.
תמיכה בריבוי דיירים דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .
לפני שניתן יהיה להשתמש ב-multi-tenancy בפרויקט Google Cloud Identity Platform, יש לאפשר לדיירים להשתתף בפרויקט זה דרך ממשק המשתמש של Cloud Console.
תצורת דייר מספקת מידע כגון שם התצוגה, מזהה הדייר ותצורת אימות הדואר האלקטרוני. עבור ניהול תצורת ספקי OIDC/SAML, יש להשתמש במופעי TenantAwareAuth
במקום Tenant
כדי לאחזר את רשימת ה-IDPs המוגדרים על דייר. בעת קביעת התצורה של ספקים אלה, שים לב שהדיירים יירשו דומיינים ברשימת ההיתרים וכתובות URI מאומתות להפניה מחדש של פרויקט האב שלהם.
גם כל שאר ההגדרות של דייר יעברו בירושה. אלה יצטרכו להיות מנוהלים מהממשק של Cloud Console.
חֲתִימָה:
export declare class Tenant
נכסים
תכונה | משנה | סוּג | תיאור |
---|---|---|---|
anonymousSignInEnabled | בוליאני | ||
הצג שם | חוּט | שם התצוגה של הדייר. | |
emailPrivacyConfig | EmailPrivacyConfig | תצורת פרטיות הדוא"ל עבור השוכר | |
emailSignInConfig | EmailSignInProviderConfig | לא מוגדר | תצורת ספק הכניסה לאימייל. | |
multiFactorConfig | MultiFactorConfig | לא מוגדר | תצורת האימות מרובת הגורמים על הדייר הנוכחי. | |
passwordPolicyConfig | PasswordPolicyConfig | תצורת מדיניות הסיסמה עבור הדייר | |
recaptchaConfig | RecaptchaConfig | לא מוגדר | תצורת האישור של תצורת ה-recaptcha של הדייר הנוכחי. | |
smsRegionConfig | SmsRegionConfig | תצורת אזורי ה-SMS לעדכון דייר. מגדיר את האזורים שבהם משתמשים רשאים לשלוח SMS אימות. זה מבוסס על קוד החיוג של מספר הטלפון של היעד. | |
זיהוי דייר | חוּט | מזהה הדייר. | |
testPhoneNumbers | { [phoneNumber: string]: string; } | המפה המכילה את מספר טלפון הבדיקה / זוגות הקוד של הדייר. |
שיטות
שיטה | משנה | תיאור |
---|---|---|
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 של אובייקט זה.