Stay organized with collections
Save and categorize content based on your preferences.
public static final class
Tenant.UpdateRequest
extends Object
A class for updating the attributes of an existing tenant.
An instance of this class can be obtained via a Tenant object, or from a tenant ID
string. Specify the changes to be made to the tenant by calling the various setter methods
available in this class.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2021-04-28 UTC."],[],[],null,["# Tenant.UpdateRequest\n\npublic static final class **Tenant.UpdateRequest** extends Object \nA class for updating the attributes of an existing tenant.\n\nAn instance of this class can be obtained via a [Tenant](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant) object, or from a tenant ID\nstring. Specify the changes to be made to the tenant by calling the various setter methods\navailable in this class. \n\n### Public Constructor Summary\n\n|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest#UpdateRequest(java.lang.String))(String tenantId) Creates a new [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest), which can be used to update the attributes of the of the tenant identified by the specified tenant ID. |\n\n### Public Method Summary\n\n|-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest) | [setDisplayName](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest#setDisplayName(java.lang.String))(String displayName) Sets the display name of the existing tenant. |\n| [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest) | [setEmailLinkSignInEnabled](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest#setEmailLinkSignInEnabled(boolean))(boolean emailLinkSignInEnabled) Sets whether to enable email link user authentication. |\n| [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest) | [setPasswordSignInAllowed](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest#setPasswordSignInAllowed(boolean))(boolean passwordSignInAllowed) Sets whether to allow email/password user authentication. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| Object | clone() |\n| boolean | equals(Object arg0) |\n| void | finalize() |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Constructors\n-------------------\n\n#### public\n**UpdateRequest**\n(String tenantId)\n\nCreates a new [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest), which can be used to update the attributes of the\nof the tenant identified by the specified tenant ID.\n\nThis method allows updating attributes of a tenant account, without first having to call\n[getTenant(String)](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/TenantManager#getTenant(java.lang.String)). \n\n##### Parameters\n\n| tenantId | a non-null, non-empty tenant ID string. |\n|----------|-----------------------------------------|\n\n##### Throws\n\n| IllegalArgumentException | If the tenant ID is null or empty. |\n|--------------------------|------------------------------------|\n\nPublic Methods\n--------------\n\n#### public [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest)\n**setDisplayName**\n(String displayName)\n\nSets the display name of the existing tenant. \n\n##### Parameters\n\n| displayName | a non-null, non-empty display name string. |\n|-------------|--------------------------------------------|\n\n#### public [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest)\n**setEmailLinkSignInEnabled**\n(boolean emailLinkSignInEnabled)\n\nSets whether to enable email link user authentication. \n\n##### Parameters\n\n| emailLinkSignInEnabled | a boolean indicating whether users can be authenticated using an email link. |\n|------------------------|------------------------------------------------------------------------------|\n\n#### public [Tenant.UpdateRequest](/docs/reference/admin/java/reference/com/google/firebase/auth/multitenancy/Tenant.UpdateRequest)\n**setPasswordSignInAllowed**\n(boolean passwordSignInAllowed)\n\nSets whether to allow email/password user authentication. \n\n##### Parameters\n\n| passwordSignInAllowed | a boolean indicating whether users can be authenticated using an email and password. |\n|-----------------------|--------------------------------------------------------------------------------------|"]]
