Stay organized with collections
Save and categorize content based on your preferences.
FirebaseAdmin.Auth.Multitenancy.Tenant
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-05-08 UTC.
[null,null,["Last updated 2024-05-08 UTC."],[],[],null,["# FirebaseAdmin.Auth.Multitenancy.Tenant Class Reference\n\nFirebaseAdmin.Auth.Multitenancy.Tenant\n======================================\n\nRepresents a tenant in a multi-tenant application.\n\nSummary\n-------\n\n[Multitenancy](/docs/reference/admin/dotnet/namespace/firebase-admin/auth/multitenancy#namespace_firebase_admin_1_1_auth_1_1_multitenancy) support requires Google Cloud Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the [GCIP documentation](https://cloud.google.com/identity-platform).\n\nBefore multitenancy can be used in a Google Cloud Identity Platform project, tenants must be allowed on that project via the Cloud Console UI.\n\nA tenant configuration provides information such as the display name, tenant identifier and email authentication configuration. For OIDC/SAML provider configuration management, [TenantAwareFirebaseAuth](/docs/reference/admin/dotnet/class/firebase-admin/auth/multitenancy/tenant-aware-firebase-auth#class_firebase_admin_1_1_auth_1_1_multitenancy_1_1_tenant_aware_firebase_auth) instances should be used instead of a [Tenant](/docs/reference/admin/dotnet/class/firebase-admin/auth/multitenancy/tenant#class_firebase_admin_1_1_auth_1_1_multitenancy_1_1_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.\n\nAll other settings of a tenant will also be inherited. These will need to be managed from the Cloud Console UI.\n\n| ### Public attributes ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|\n| [DisplayName](#class_firebase_admin_1_1_auth_1_1_multitenancy_1_1_tenant_1addf318ccee5b3c02bc9cf1dd1b023f1a)` =\u003e this.args.DisplayName` | `string` Gets the tenant display name. |\n| [EmailLinkSignInEnabled](#class_firebase_admin_1_1_auth_1_1_multitenancy_1_1_tenant_1a7d89ca274d8141750655e919d295b2a2)` =\u003e this.args.EmailLinkSignInEnabled ?? false` | `bool` Gets a value indicating whether the email link sign-in is enabled. |\n| [PasswordSignUpAllowed](#class_firebase_admin_1_1_auth_1_1_multitenancy_1_1_tenant_1a5ac5dcba0a3062f6f6edc7ff712c3d35)` =\u003e this.args.PasswordSignUpAllowed ?? false` | `bool` Gets a value indicating whether the email sign-in provider is enabled. |\n| [TenantId](#class_firebase_admin_1_1_auth_1_1_multitenancy_1_1_tenant_1a95cd932d45f3b1ece68dadf08cc9fe44)` =\u003e this.ExtractResourceId(this.args.Name)` | `string` Gets the tenant identifier. |\n\nPublic attributes\n-----------------\n\n### DisplayName\n\n```text\nstring DisplayName =\u003e this.args.DisplayName\n``` \nGets the tenant display name. \n\n### EmailLinkSignInEnabled\n\n```text\nbool EmailLinkSignInEnabled =\u003e this.args.EmailLinkSignInEnabled ?? false\n``` \nGets a value indicating whether the email link sign-in is enabled. \n\n### PasswordSignUpAllowed\n\n```text\nbool PasswordSignUpAllowed =\u003e this.args.PasswordSignUpAllowed ?? false\n``` \nGets a value indicating whether the email sign-in provider is enabled. \n\n### TenantId\n\n```text\nstring TenantId =\u003e this.ExtractResourceId(this.args.Name)\n``` \nGets the tenant identifier."]]
