supertokens-node/recipe/multitenancy/types

References documentation for the supertokens-node/recipe/multitenancy/types package

Type Aliases

type APIInterface = object;

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

type APIOptions = object;

Property	Type	Defined in
`allAvailableFirstFactors`	`string`[]	recipe/multitenancy/types.ts
`config`	`TypeNormalisedInput`	recipe/multitenancy/types.ts
`isInServerlessEnv`	`boolean`	recipe/multitenancy/types.ts
`recipeId`	`string`	recipe/multitenancy/types.ts
`recipeImplementation`	`RecipeInterface`	recipe/multitenancy/types.ts
`req`	`BaseRequest`	recipe/multitenancy/types.ts
`res`	`BaseResponse`	recipe/multitenancy/types.ts
`staticFirstFactors`	`string`[] \| `undefined`	recipe/multitenancy/types.ts
`staticThirdPartyProviders`	`ProviderInput`[]	recipe/multitenancy/types.ts

type RecipeInterface = object;

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
`createOrUpdateTenant`	(`input`) => `Promise`<{ `createdNew`: `boolean`; `status`: `"OK"`; }>	recipe/multitenancy/types.ts
`createOrUpdateThirdPartyConfig`	(`input`) => `Promise`<{ `createdNew`: `boolean`; `status`: `"OK"`; }>	recipe/multitenancy/types.ts
`deleteTenant`	(`input`) => `Promise`<{ `didExist`: `boolean`; `status`: `"OK"`; }>	recipe/multitenancy/types.ts
`deleteThirdPartyConfig`	(`input`) => `Promise`<{ `didConfigExist`: `boolean`; `status`: `"OK"`; }>	recipe/multitenancy/types.ts
`disassociateUserFromTenant`	(`input`) => `Promise`<{ `status`: `"OK"`; `wasAssociated`: `boolean`; }>	recipe/multitenancy/types.ts
`getTenant`	(`input`) => `Promise`<`object` & `TenantConfig` \| `undefined`>	recipe/multitenancy/types.ts
`getTenantId`	(`input`) => `Promise`<`string`>	recipe/multitenancy/types.ts
`listAllTenants`	(`input`) => `Promise`<{ `status`: `"OK"`; `tenants`: `TenantConfig` & `object`[]; }>	recipe/multitenancy/types.ts

type TenantConfig = object;

Property	Type	Defined in
`coreConfig`	`object`	recipe/multitenancy/types.ts
`firstFactors?`	`string`[]	recipe/multitenancy/types.ts
`requiredSecondaryFactors?`	`string`[]	recipe/multitenancy/types.ts
`thirdParty`	`object`	recipe/multitenancy/types.ts
`thirdParty.providers`	`ProviderConfig`[]	recipe/multitenancy/types.ts

type TypeInput = object;

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

type TypeNormalisedInput = object;

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