UpdateTenantRequest interface

Interface representing the properties to update on the provided tenant.

Signature:

export interface UpdateTenantRequest 

Properties

Property	Type	Description
anonymousSignInEnabled	boolean	Whether the anonymous provider is enabled.
displayName	string	The tenant display name.
emailPrivacyConfig	EmailPrivacyConfig	The email privacy configuration for the tenant
emailSignInConfig	EmailSignInProviderConfig	The email sign in configuration.
multiFactorConfig	MultiFactorConfig	The multi-factor auth configuration to update on the tenant.
passwordPolicyConfig	PasswordPolicyConfig	The password policy configuration for the tenant
recaptchaConfig	RecaptchaConfig	The reCAPTCHA configuration to update on the tenant. By enabling reCAPTCHA Enterprise integration, you are agreeing to the reCAPTCHA Enterprise Term of Service.
smsRegionConfig	SmsRegionConfig	The SMS configuration to update on the project.
testPhoneNumbers	{ [phoneNumber: string]: string; } | null	The updated map containing the test phone number / code pairs for the tenant. Passing null clears the previously save phone number / code pairs.

UpdateTenantRequest.anonymousSignInEnabled

Whether the anonymous provider is enabled.

Signature:

anonymousSignInEnabled?: boolean;

UpdateTenantRequest.displayName

The tenant display name.

Signature:

displayName?: string;

UpdateTenantRequest.emailPrivacyConfig

The email privacy configuration for the tenant

Signature:

emailPrivacyConfig?: EmailPrivacyConfig;

UpdateTenantRequest.emailSignInConfig

The email sign in configuration.

Signature:

emailSignInConfig?: EmailSignInProviderConfig;

UpdateTenantRequest.multiFactorConfig

The multi-factor auth configuration to update on the tenant.

Signature:

multiFactorConfig?: MultiFactorConfig;

UpdateTenantRequest.passwordPolicyConfig

The password policy configuration for the tenant

Signature:

passwordPolicyConfig?: PasswordPolicyConfig;

UpdateTenantRequest.recaptchaConfig

The reCAPTCHA configuration to update on the tenant. By enabling reCAPTCHA Enterprise integration, you are agreeing to the reCAPTCHA Enterprise Term of Service.

Signature:

recaptchaConfig?: RecaptchaConfig;

UpdateTenantRequest.smsRegionConfig

The SMS configuration to update on the project.

Signature:

smsRegionConfig?: SmsRegionConfig;

UpdateTenantRequest.testPhoneNumbers

The updated map containing the test phone number / code pairs for the tenant. Passing null clears the previously save phone number / code pairs.

Signature:

testPhoneNumbers?: {
        [phoneNumber: string]: string;
    } | null;