Tenant class

يمثل هذا الإعداد إعدادات المستأجر.

يتطلب دعم الإقامة المتعددة استخدام GCIP من Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على وثائق GCIP.

قبل استخدام مدة إقامة متعددة في مشروع Google Cloud Identity Platform، يجب السماح بالمستأجرين في هذا المشروع من خلال واجهة مستخدم Cloud Console.

يوفّر إعداد المستأجر معلومات، مثل الاسم المعروض ومعرّف المستأجر وإعدادات مصادقة البريد الإلكتروني. لإدارة إعداد موفّر خدمة OIDC/SAML، يجب استخدام نسخة افتراضية من TenantAwareAuth بدلاً من Tenant لاسترداد قائمة موفِّري الهوية الذين تم ضبطهم على حساب مستأجر. عند ضبط هؤلاء الموفّرين، يُرجى ملاحظة أنّ المستأجرين سيكتسبون النطاقات المضافة إلى القائمة البيضاء ومعرّفات الموارد المنتظمة (URI) لإعادة التوجيه التي تمت مصادقتها لمشروعهم الرئيسي.

سيتم أيضًا اكتساب جميع الإعدادات الأخرى الخاصة بالمستأجر. ويجب إدارتها من خلال واجهة مستخدم Cloud Console.

Signature:

export declare class Tenant 

أماكن إقامة

الموقع المعدِّلات النوع الوصف
anonymousSignInEnabled قيمة منطقية
displayName السلسلة الاسم المعروض للمستأجر
emailPrivacyConfig EmailPrivacyConfig تهيئة خصوصية البريد الإلكتروني للمستأجر
emailSignInConfig EmailSignInProviderConfig | غير محدّدة إعدادات مزوِّد خدمة تسجيل الدخول إلى البريد الإلكتروني
multiFactorConfig MultiFactorConfig | غير محدّدة إعداد المصادقة المتعدّدة العوامل في المستأجر الحالي
passwordPolicyConfig PasswordPolicyConfig إعداد سياسة كلمة المرور للمستأجر
recaptchaConfig RecaptchaConfig | غير محدّدة إعدادات المصادقة الخاصة بإعدادات reCAPTCHA للمستأجر الحالي.
smsRegionConfig SmsRegionConfig إعداد مناطق الرسائل القصيرة SMS لتحديث مستأجر. تحدِّد هذه السياسة المناطق التي يُسمح فيها للمستخدمين بإرسال رسالة قصيرة SMS لإثبات الملكية. ويعتمد ذلك على رمز الاتصال لرقم الهاتف الوجهة.
tenantId السلسلة معرّف المستأجر.
testPhoneNumbers { [phoneNumber: string]: string; } الخريطة التي تحتوي على رقم الهاتف التجريبي / أزواج الرموز الخاصة بالمستأجر.

الطُرق

الطريقة المعدِّلات الوصف
toJSON() تعرض تمثيلاً بتنسيق JSON لهذا الكائن.

Tenant.anonymousSignInEnabled

Signature:

readonly anonymousSignInEnabled: boolean;

اسم المستأجر

الاسم المعروض للمستأجر

Signature:

readonly displayName?: string;

Tenant.emailPrivacyConfig.

تهيئة خصوصية البريد الإلكتروني للمستأجر

Signature:

readonly emailPrivacyConfig?: EmailPrivacyConfig;

Tenant.emailSignInConfig

إعدادات مزوِّد خدمة تسجيل الدخول إلى البريد الإلكتروني

Signature:

get emailSignInConfig(): EmailSignInProviderConfig | undefined;

المستأجر.multiFactorConfig

إعداد المصادقة المتعدّدة العوامل في المستأجر الحالي

Signature:

get multiFactorConfig(): MultiFactorConfig | undefined;

Tenant.passwordPolicyConfig

إعداد سياسة كلمة المرور للمستأجر

Signature:

readonly passwordPolicyConfig?: PasswordPolicyConfig;

Tenant.recaptchaConfig

إعدادات المصادقة الخاصة بإعدادات reCAPTCHA للمستأجر الحالي.

Signature:

get recaptchaConfig(): RecaptchaConfig | undefined;

إعدادات Tenant.smsRegionConfig

إعداد مناطق الرسائل القصيرة SMS لتحديث مستأجر. تحدِّد هذه السياسة المناطق التي يُسمح فيها للمستخدمين بإرسال رسالة قصيرة SMS لإثبات الملكية. ويعتمد ذلك على رمز الاتصال لرقم الهاتف الوجهة.

Signature:

readonly smsRegionConfig?: SmsRegionConfig;

رقم تعريف Tenant.tenantId

معرّف المستأجر.

Signature:

readonly tenantId: string;

Tenant.testPhoneNumbers

الخريطة التي تحتوي على رقم الهاتف التجريبي / أزواج الرموز الخاصة بالمستأجر.

Signature:

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

Tenant.toJSON()

تعرض تمثيلاً بتنسيق JSON لهذا الكائن.

Signature:

toJSON(): object;

المرتجعات:

كائن

تمثّل هذه السمة تمثيلاً بتنسيق JSON لهذا العنصر.