Options
All
  • Public
  • Public/Protected
  • All
Menu

These are the SDK reference docs. If you’re looking for docs to implement SuperTokens, you might want to check out the User Guides

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static AllowedDomainsClaim

AllowedDomainsClaim: AllowedDomainsClaimClass = AllowedDomainsClaim

Methods

Static getLoginMethods

  • 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 from the backend

    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

Static getTenantId

  • getTenantId(input?: { userContext?: any }): undefined | string | Promise<undefined | string>

  • Gets enabled login methods and their configuration from the backend

    Parameters

    • Optional input: { userContext?: any }
      • Optional userContext?: any

    Returns undefined | string | Promise<undefined | string>

    Promise<string | undefined> | string | undefined

Static init

  • init(config?: UserInput): CreateRecipeFunction<"GET_LOGIN_METHODS">

Generated using TypeDoc