يمثل تكوين المستأجر.
يتطلب دعم الإيجارات المتعددة منصة هوية Google Cloud (GCIP). لمعرفة المزيد حول GCIP، بما في ذلك الأسعار والميزات، راجع وثائق GCIP .
قبل أن يتم استخدام الإيجار المتعدد في مشروع Google Cloud Identity Platform، يجب السماح للمستأجرين بالمشاركة في هذا المشروع عبر واجهة مستخدم Cloud Console.
يوفر تكوين المستأجر معلومات مثل اسم العرض ومعرف المستأجر وتكوين مصادقة البريد الإلكتروني. بالنسبة لإدارة تكوين موفر OIDC/SAML، يجب استخدام مثيلات TenantAwareAuth
بدلاً من Tenant
لاسترداد قائمة IdPs التي تم تكوينها على المستأجر. عند تكوين هؤلاء الموفرين، لاحظ أن المستأجرين سوف يرثون نطاقات القائمة البيضاء وسيقومون بإعادة توجيه URIs للمشروع الأصلي.
سيتم أيضًا توريث جميع الإعدادات الأخرى للمستأجر. ستحتاج إلى إدارتها من واجهة مستخدم Cloud Console.
إمضاء:
export declare class Tenant
ملكيات
ملكية | الصفات التعريفية | يكتب | وصف |
---|---|---|---|
AnonymousSignInEnabled | منطقية | ||
اسم العرض | خيط | اسم عرض المستأجر. | |
البريد الإلكتروني خصوصية التكوين | تكوين خصوصية البريد الإلكتروني | تكوين خصوصية البريد الإلكتروني للمستأجر | |
البريد الإلكترونيSignInConfig | البريد الإلكترونيSignInProviderConfig | غير معرف | تكوين موفر تسجيل الدخول عبر البريد الإلكتروني. | |
multiFactorConfig | تكوين متعدد العوامل | غير معرف | تكوين المصادقة متعدد العوامل على المستأجر الحالي. | |
تكوين سياسة كلمة المرور | تكوين سياسة كلمة المرور | تكوين سياسة كلمة المرور للمستأجر | |
recaptchaConfig | ريكابتشاكونفيج | غير معرف | تكوين recaptcha config auth للمستأجر الحالي. | |
smsRegionConfig | SmsRegionConfig | تكوين مناطق 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 config auth للمستأجر الحالي.
إمضاء:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
تكوين مناطق SMS لتحديث المستأجر. تكوين المناطق التي يُسمح فيها للمستخدمين بإرسال رسائل نصية قصيرة للتحقق. يعتمد ذلك على رمز الاتصال الخاص برقم الهاتف الوجهة.
إمضاء:
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
معرف المستأجر.
إمضاء:
readonly tenantId: string;
Tenant.testPhoneNumbers
الخريطة التي تحتوي على رقم الهاتف / أزواج الرموز الاختبارية للمستأجر.
إمضاء:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
تقوم بإرجاع تمثيل JSON قابل للتسلسل لهذا الكائن.
إمضاء:
toJSON(): object;
عائدات:
هدف
تمثيل JSON قابل للتسلسل لهذا الكائن.