UpdateTenantRequest interface

Interface representing the properties to update on the provided tenant.

Signature:

exportinterfaceUpdateTenantRequest

Properties

PropertyTypeDescription
anonymousSignInEnabledbooleanWhether the anonymous provider is enabled.
displayNamestringThe tenant display name.
emailPrivacyConfigEmailPrivacyConfigThe email privacy configuration for the tenant
emailSignInConfigEmailSignInProviderConfigThe email sign in configuration.
multiFactorConfigMultiFactorConfigThe multi-factor auth configuration to update on the tenant.
passwordPolicyConfigPasswordPolicyConfigThe password policy configuration for the tenant
recaptchaConfigRecaptchaConfigThe reCAPTCHA configuration to update on the tenant. By enabling reCAPTCHA Enterprise integration, you are agreeing to the reCAPTCHA EnterpriseTerm of Service.
smsRegionConfigSmsRegionConfigThe SMS configuration to update on the project.
testPhoneNumbers{ [phoneNumber: string]: string; } | nullThe 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 EnterpriseTerm 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;

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-09-29 UTC.