Tenant class

یک پیکربندی مستاجر را نشان می دهد.

پشتیبانی چند اجاره ای به پلتفرم هویت Google Cloud (GCIP) نیاز دارد. برای کسب اطلاعات بیشتر درباره GCIP، از جمله قیمت و ویژگی‌ها، به مستندات GCIP مراجعه کنید .

قبل از اینکه بتوان از چند اجاره‌نشینی در پروژه Google Cloud Identity Platform استفاده کرد، مستاجران باید از طریق رابط کاربری Cloud Console اجازه حضور در آن پروژه را داشته باشند.

پیکربندی مستاجر اطلاعاتی مانند نام نمایشی، شناسه مستاجر و پیکربندی احراز هویت ایمیل را ارائه می دهد. برای مدیریت پیکربندی ارائه‌دهنده OIDC/SAML، باید از نمونه‌های TenantAwareAuth به جای یک Tenant برای بازیابی فهرست IdP‌های پیکربندی شده در یک مستاجر استفاده شود. هنگام پیکربندی این ارائه‌دهندگان، توجه داشته باشید که مستاجرین دامنه‌های لیست سفید و URIهای احراز هویت شده تغییر مسیر پروژه والد خود را به ارث خواهند برد.

تمام تنظیمات دیگر یک مستاجر نیز به ارث می رسد. اینها باید از رابط کاربری Cloud Console مدیریت شوند.

امضا:

export declare class Tenant 

خواص

مواد و روش ها

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 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-Serializable از این شی.