FirebaseAdmin.
Represents a tenant in a multi-tenant application.
Summary
Multitenancy support requires Google Cloud Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.
Before multitenancy can be used in 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, TenantAwareFirebaseAuth 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.
Public attributes |
|
|---|---|
DisplayName => this.args.DisplayName
|
string
Gets the tenant display name.
|
EmailLinkSignInEnabled => this.args.EmailLinkSignInEnabled ?? false
|
bool
Gets a value indicating whether the email link sign-in is enabled.
|
PasswordSignUpAllowed => this.args.PasswordSignUpAllowed ?? false
|
bool
Gets a value indicating whether the email sign-in provider is enabled.
|
TenantId => this.ExtractResourceId(this.args.Name)
|
string
Gets the tenant identifier.
|
Public attributes
DisplayName
string DisplayName => this.args.DisplayName
Gets the tenant display name.
EmailLinkSignInEnabled
bool EmailLinkSignInEnabled => this.args.EmailLinkSignInEnabled ?? false
Gets a value indicating whether the email link sign-in is enabled.
PasswordSignUpAllowed
bool PasswordSignUpAllowed => this.args.PasswordSignUpAllowed ?? false
Gets a value indicating whether the email sign-in provider is enabled.
TenantId
string TenantId => this.ExtractResourceId(this.args.Name)
Gets the tenant identifier.