Options
All
  • Public
  • Public/Protected
  • All
Menu

Module recipe/multitenancy

Index

Type Aliases

PostAPIHookContext: RecipePostAPIHookContext<PreAndPostAPIHookAction>
PreAPIHookContext: RecipePreAPIHookContext<PreAndPostAPIHookAction>
PreAndPostAPIHookAction: "GET_LOGIN_METHODS"
RecipeInterface: { getLoginMethods: any; getTenantId: any }

Type declaration

  • getLoginMethods:function
    • getLoginMethods(input: { options?: RecipeFunctionOptions; tenantId?: string; userContext: any }): Promise<{ fetchResponse: Response; firstFactors: string[]; status: "OK"; thirdParty: { providers: { id: string; name: string }[] } }>
    • Gets enabled login methods and their configuration

      throws

      STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

      Parameters

      Returns Promise<{ fetchResponse: Response; firstFactors: string[]; status: "OK"; thirdParty: { providers: { id: string; name: string }[] } }>

      {status: OK, emailpassword, passwordless, thirdParty} if successful

  • getTenantId:function
    • getTenantId(input: { userContext: any }): undefined | string | Promise<undefined | string>
UserInput: { override?: { functions?: any } } & RecipeModuleUserInput<PreAndPostAPIHookAction>

Variables

AllowedDomainsClaim: AllowedDomainsClaimClass = ...

Functions

  • getLoginMethods(input?: { options?: RecipeFunctionOptions; tenantId?: string; userContext?: any }): Promise<{ fetchResponse: Response; firstFactors: string[]; status: "OK"; thirdParty: { providers: { id: string; name: string }[] } }>
  • getTenantId(input?: { userContext?: any }): undefined | string | Promise<undefined | string>
  • init(config?: UserInput): CreateRecipeFunction<"GET_LOGIN_METHODS">

Generated using TypeDoc