MultiTenancy Types

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/multitenancy/types.ts:145

Properties

Property	Type	Defined in
loginMethodsGET	(input) => Promise< | { emailPassword: { enabled: boolean; }; firstFactors: string[]; passwordless: { enabled: boolean; }; status: "OK"; thirdParty: { enabled: boolean; providers: object[]; }; } | GeneralErrorResponse>	recipe/multitenancy/types.ts:146

APIOptions

type APIOptions = object;

Defined in: recipe/multitenancy/types.ts:133

Properties

Property	Type	Defined in
allAvailableFirstFactors	string[]	recipe/multitenancy/types.ts:141
config	TypeNormalisedInput	recipe/multitenancy/types.ts:135
isInServerlessEnv	boolean	recipe/multitenancy/types.ts:137
recipeId	string	recipe/multitenancy/types.ts:136
recipeImplementation	RecipeInterface	recipe/multitenancy/types.ts:134
req	BaseRequest	recipe/multitenancy/types.ts:138
res	BaseResponse	recipe/multitenancy/types.ts:139
staticFirstFactors	string[] | undefined	recipe/multitenancy/types.ts:142
staticThirdPartyProviders	ProviderInput[]	recipe/multitenancy/types.ts:140

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/multitenancy/types.ts:55

Properties

Property	Type	Defined in
associateUserToTenant	(input) => Promise< | { status: "OK"; wasAlreadyAssociated: boolean; } | { status: | "UNKNOWN_USER_ID_ERROR" | "EMAIL_ALREADY_EXISTS_ERROR" | "PHONE_NUMBER_ALREADY_EXISTS_ERROR" | "THIRD_PARTY_USER_ALREADY_EXISTS_ERROR"; } | { reason: string; status: "ASSOCIATION_NOT_ALLOWED_ERROR"; }>	recipe/multitenancy/types.ts:102
createOrUpdateTenant	(input) => Promise<{ createdNew: boolean; status: "OK"; }>	recipe/multitenancy/types.ts:59
createOrUpdateThirdPartyConfig	(input) => Promise<{ createdNew: boolean; status: "OK"; }>	recipe/multitenancy/types.ts:87
deleteTenant	(input) => Promise<{ didExist: boolean; status: "OK"; }>	recipe/multitenancy/types.ts:71
deleteThirdPartyConfig	(input) => Promise<{ didConfigExist: boolean; status: "OK"; }>	recipe/multitenancy/types.ts:96
disassociateUserFromTenant	(input) => Promise<{ status: "OK"; wasAssociated: boolean; }>	recipe/multitenancy/types.ts:123
getTenant	(input) => Promise<object & TenantConfig | undefined>	recipe/multitenancy/types.ts:75
getTenantId	(input) => Promise<string>	recipe/multitenancy/types.ts:56
listAllTenants	(input) => Promise<{ status: "OK"; tenants: TenantConfig & object[]; }>	recipe/multitenancy/types.ts:81

TenantConfig

type TenantConfig = object;

Defined in: recipe/multitenancy/types.ts:46

Properties

Property	Type	Defined in
coreConfig	object	recipe/multitenancy/types.ts:52
firstFactors?	string[]	recipe/multitenancy/types.ts:50
requiredSecondaryFactors?	string[]	recipe/multitenancy/types.ts:51
thirdParty	object	recipe/multitenancy/types.ts:47
thirdParty.providers	ProviderConfig[]	recipe/multitenancy/types.ts:48

TypeInput

type TypeInput = object;

Defined in: recipe/multitenancy/types.ts:22

Properties

Property	Type	Defined in
getAllowedDomainsForTenantId?	(tenantId, userContext) => Promise<string[] | undefined>	recipe/multitenancy/types.ts:23
override?	object	recipe/multitenancy/types.ts:25
override.apis?	(originalImplementation, builder) => APIInterface	recipe/multitenancy/types.ts:30
override.functions?	(originalImplementation, builder) => RecipeInterface	recipe/multitenancy/types.ts:26

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/multitenancy/types.ts:34

Properties

Property	Type	Defined in
getAllowedDomainsForTenantId?	(tenantId, userContext) => Promise<string[] | undefined>	recipe/multitenancy/types.ts:35
override	object	recipe/multitenancy/types.ts:37
override.apis	(originalImplementation, builder) => APIInterface	recipe/multitenancy/types.ts:42
override.functions	(originalImplementation, builder) => RecipeInterface	recipe/multitenancy/types.ts:38