Module recipe/multitenancy

loginMethodsGET:function

• loginMethodsGET(input: { clientType?: string; options: APIOptions; tenantId: string; userContext: UserContext }): Promise<GeneralErrorResponse | { emailPassword: { enabled: boolean }; firstFactors: string[]; passwordless: { enabled: boolean }; status: "OK"; thirdParty: { enabled: boolean; providers: { id: string; name?: string }[] } }>

• Parameters

  • input: { clientType?: string; options: APIOptions; tenantId: string; userContext: UserContext }

    • Optional clientType?: string

    • options: APIOptions

    • tenantId: string

    • userContext: UserContext

  Returns Promise<GeneralErrorResponse | { emailPassword: { enabled: boolean }; firstFactors: string[]; passwordless: { enabled: boolean }; status: "OK"; thirdParty: { enabled: boolean; providers: { id: string; name?: string }[] } }>

allAvailableFirstFactors: string[]

config: TypeNormalisedInput

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

staticFirstFactors: string[] | undefined

staticThirdPartyProviders: ProviderInput[]

associateUserToTenant:function

• associateUserToTenant(input: { recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext }): 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" }>

• Parameters

  • input: { recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext }

    • recipeUserId: RecipeUserId

    • tenantId: string

    • userContext: UserContext

  Returns 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" }>

createOrUpdateTenant:function

• createOrUpdateTenant(input: { config?: { coreConfig?: {}; emailPasswordEnabled?: boolean; firstFactors?: string[]; passwordlessEnabled?: boolean; requiredSecondaryFactors?: string[]; thirdPartyEnabled?: boolean }; tenantId: string; userContext: UserContext }): Promise<{ createdNew: boolean; status: "OK" }>

• Parameters

  • input: { config?: { coreConfig?: {}; emailPasswordEnabled?: boolean; firstFactors?: string[]; passwordlessEnabled?: boolean; requiredSecondaryFactors?: string[]; thirdPartyEnabled?: boolean }; tenantId: string; userContext: UserContext }

    • Optional config?: { coreConfig?: {}; emailPasswordEnabled?: boolean; firstFactors?: string[]; passwordlessEnabled?: boolean; requiredSecondaryFactors?: string[]; thirdPartyEnabled?: boolean }

      • Optional coreConfig?: {}

        • [key: string]: any

      • Optional emailPasswordEnabled?: boolean

      • Optional firstFactors?: string[]

      • Optional passwordlessEnabled?: boolean

      • Optional requiredSecondaryFactors?: string[]

      • Optional thirdPartyEnabled?: boolean

    • tenantId: string

    • userContext: UserContext

  Returns Promise<{ createdNew: boolean; status: "OK" }>

createOrUpdateThirdPartyConfig:function

• createOrUpdateThirdPartyConfig(input: { config: ProviderConfig; skipValidation?: boolean; tenantId: string; userContext: UserContext }): Promise<{ createdNew: boolean; status: "OK" }>

• Parameters

  • input: { config: ProviderConfig; skipValidation?: boolean; tenantId: string; userContext: UserContext }

    • config: ProviderConfig

    • Optional skipValidation?: boolean

    • tenantId: string

    • userContext: UserContext

  Returns Promise<{ createdNew: boolean; status: "OK" }>

deleteTenant:function

• deleteTenant(input: { tenantId: string; userContext: UserContext }): Promise<{ didExist: boolean; status: "OK" }>

• Parameters

  • input: { tenantId: string; userContext: UserContext }

    • tenantId: string

    • userContext: UserContext

  Returns Promise<{ didExist: boolean; status: "OK" }>

deleteThirdPartyConfig:function

• deleteThirdPartyConfig(input: { tenantId: string; thirdPartyId: string; userContext: UserContext }): Promise<{ didConfigExist: boolean; status: "OK" }>

• Parameters

  • input: { tenantId: string; thirdPartyId: string; userContext: UserContext }

    • tenantId: string

    • thirdPartyId: string

    • userContext: UserContext

  Returns Promise<{ didConfigExist: boolean; status: "OK" }>

disassociateUserFromTenant:function

• disassociateUserFromTenant(input: { recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext }): Promise<{ status: "OK"; wasAssociated: boolean }>

• Parameters

  • input: { recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext }

    • recipeUserId: RecipeUserId

    • tenantId: string

    • userContext: UserContext

  Returns Promise<{ status: "OK"; wasAssociated: boolean }>

getTenant:function

• getTenant(input: { tenantId: string; userContext: UserContext }): Promise<undefined | { status: "OK" } & TenantConfig>

• Parameters

  • input: { tenantId: string; userContext: UserContext }

    • tenantId: string

    • userContext: UserContext

  Returns Promise<undefined | { status: "OK" } & TenantConfig>

getTenantId:function

• getTenantId(input: { tenantIdFromFrontend: string; userContext: UserContext }): Promise<string>

• Parameters

  • input: { tenantIdFromFrontend: string; userContext: UserContext }

    • tenantIdFromFrontend: string

    • userContext: UserContext

  Returns Promise<string>

listAllTenants:function

• listAllTenants(input: { userContext: UserContext }): Promise<{ status: "OK"; tenants: (TenantConfig & { tenantId: string })[] }>

• Parameters

  • input: { userContext: UserContext }

    • userContext: UserContext

  Returns Promise<{ status: "OK"; tenants: (TenantConfig & { tenantId: string })[] }>