Tenant.CreateRequest

public static final class Tenant.CreateRequest extends Object

A specification class for creating a new tenant.

Set the initial attributes of the new tenant by calling various setter methods available in this class. None of the attributes are required.

Public Constructor Summary

CreateRequest()
Creates a new Tenant.CreateRequest, which can be used to create a new tenant.

Public Method Summary

Tenant.CreateRequest
setDisplayName(String displayName)
Sets the display name for the new tenant.
Tenant.CreateRequest
setEmailLinkSignInEnabled(boolean emailLinkSignInEnabled)
Sets whether to enable email link user authentication.
Tenant.CreateRequest
setPasswordSignInAllowed(boolean passwordSignInAllowed)
Sets whether to allow email/password user authentication.

Inherited Method Summary

Public Constructors

public CreateRequest ()

Creates a new Tenant.CreateRequest, which can be used to create a new tenant.

The returned object should be passed to createTenant(CreateRequest) to register the tenant information persistently.

Public Methods

public Tenant.CreateRequest setDisplayName (String displayName)

Sets the display name for the new tenant.

Parameters
displayName a non-null, non-empty display name string.

public Tenant.CreateRequest setEmailLinkSignInEnabled (boolean emailLinkSignInEnabled)

Sets whether to enable email link user authentication.

Parameters
emailLinkSignInEnabled a boolean indicating whether users can be authenticated using an email link.

public Tenant.CreateRequest setPasswordSignInAllowed (boolean passwordSignInAllowed)

Sets whether to allow email/password user authentication.

Parameters
passwordSignInAllowed a boolean indicating whether users can be authenticated using an email and password.