Tenant class

Stay organized with collections Save and categorize content based on your preferences.

Represents a tenant configuration.

Multi-tenancy support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

Before multi-tenancy can be used on a Google Cloud Identity Platform project, tenants must be allowed on that project via the Cloud Console UI.

A tenant configuration provides information such as the display name, tenant identifier and email authentication configuration. For OIDC/SAML provider configuration management, TenantAwareAuth instances should be used instead of a Tenant to retrieve the list of configured IdPs on a tenant. When configuring these providers, note that tenants will inherit whitelisted domains and authenticated redirect URIs of their parent project.

All other settings of a tenant will also be inherited. These will need to be managed from the Cloud Console UI.

Signature:

exportdeclareclassTenant

Properties

Methods

Tenant.anonymousSignInEnabled

Signature:

readonlyanonymousSignInEnabled:boolean;

Tenant.displayName

The tenant display name.

Signature:

readonlydisplayName?:string;

Tenant.emailPrivacyConfig

The email privacy configuration for the tenant

Signature:

readonlyemailPrivacyConfig?:EmailPrivacyConfig;

Tenant.emailSignInConfig

The email sign in provider configuration.

Signature:

getemailSignInConfig():EmailSignInProviderConfig|undefined;

Tenant.multiFactorConfig

The multi-factor auth configuration on the current tenant.

Signature:

getmultiFactorConfig():MultiFactorConfig|undefined;

Tenant.passwordPolicyConfig

The password policy configuration for the tenant

Signature:

readonlypasswordPolicyConfig?:PasswordPolicyConfig;

Tenant.recaptchaConfig

The recaptcha config auth configuration of the current tenant.

Signature:

getrecaptchaConfig():RecaptchaConfig|undefined;

Tenant.smsRegionConfig

The SMS Regions Config to update a tenant. Configures the regions where users are allowed to send verification SMS. This is based on the calling code of the destination phone number.

Signature:

readonlysmsRegionConfig?:SmsRegionConfig;

Tenant.tenantId

The tenant identifier.

Signature:

readonlytenantId:string;

Tenant.testPhoneNumbers

The map containing the test phone number / code pairs for the tenant.

Signature:

readonlytestPhoneNumbers?:{[phoneNumber:string]:string;};

Tenant.toJSON()

Returns a JSON-serializable representation of this object.

Signature:

toJSON():object;

Returns:

object

A JSON-serializable representation of this object.