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

Module recipe/thirdpartyemailpassword

Index

References

Classes

Type aliases

Variables

Functions

References

Apple

Re-exports Apple

EmailVerificationTheme

Renames and re-exports __type

Facebook

Re-exports Facebook

Github

Re-exports Github

Google

Re-exports Google

ResetPasswordUsingTokenTheme

Renames and re-exports __type

SignInAndUpTheme

Renames and re-exports __type

Type aliases

GetRedirectionURLContext

GetRedirectionURLContext: GetRedirectionURLContext | GetRedirectionURLContext

OnHandleEventContext

OnHandleEventContext: OnHandleEventContext | OnHandleEventContext

PreAPIHookContext

PreAPIHookContext: PreAPIHookContext | PreAPIHookContext

RecipeInterface

RecipeInterface: { doesEmailExist: any; getOAuthAuthorisationURL: any; getOAuthState: any; redirectToThirdPartyLogin: any; sendPasswordResetEmail: any; setOAuthState: any; signInAndUp: any; submitNewPassword: any }

Type declaration

  • doesEmailExist:function
    • doesEmailExist(input: { config: EPConfig; email: string }): Promise<boolean>
  • getOAuthAuthorisationURL:function
    • getOAuthAuthorisationURL(input: { config: TPConfig; thirdPartyId: string }): Promise<string>
  • getOAuthState:function
    • getOAuthState(): undefined | StateObject
  • redirectToThirdPartyLogin:function
    • redirectToThirdPartyLogin(input: { config: TPConfig; state?: StateObject; thirdPartyId: string }): Promise<{ status: "OK" | "ERROR" }>
  • sendPasswordResetEmail:function
    • sendPasswordResetEmail(input: { config: EPConfig; formFields: { id: string; value: string }[] }): Promise<{ status: "OK" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

    • Parameters

      • input: { config: EPConfig; formFields: { id: string; value: string }[] }
        • config: EPConfig
        • formFields: { id: string; value: string }[]

      Returns Promise<{ status: "OK" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

  • setOAuthState:function
    • setOAuthState(state: StateObject): void
  • signInAndUp:function
    • signInAndUp(input: SignInAndUpInput): Promise<SignInAndUpOutput>
  • submitNewPassword:function
    • submitNewPassword(input: { config: EPConfig; formFields: { id: string; value: string }[]; token: string }): Promise<{ status: "OK" | "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

    • Parameters

      • input: { config: EPConfig; formFields: { id: string; value: string }[]; token: string }
        • config: EPConfig
        • formFields: { id: string; value: string }[]
        • token: string

      Returns Promise<{ status: "OK" | "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>

UserInput

UserInput: { disableEmailPassword?: boolean; oAuthCallbackScreen?: FeatureBaseConfig; override?: { components?: ComponentOverrideMap; functions?: any } & AuthRecipeUserInputOverride; resetPasswordUsingTokenFeature?: ResetPasswordUsingTokenUserInput; signInAndUpFeature?: SignInAndUpFeatureUserInput } & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAPIHookContext, OnHandleEventContext>

Variables

ThirdPartyEmailPasswordAuth

ThirdPartyEmailPasswordAuth: React.FC<PropsWithChildren<{ requireAuth?: boolean; onSessionExpired?: any }>> = ...

Functions

Const EmailVerification

  • EmailVerification(prop?: any): Element

Const ResetPasswordUsingToken

  • ResetPasswordUsingToken(prop?: any): Element

Const SignInAndUp

  • SignInAndUp(prop?: any): Element

Const ThirdPartySignInAndUpCallback

  • ThirdPartySignInAndUpCallback(prop?: any): Element

Const init

Const isEmailVerified

  • isEmailVerified(): Promise<boolean>

Const redirectToAuth

  • redirectToAuth(input?: "signin" | "signup" | { redirectBack?: false | true; show?: "signin" | "signup" }): Promise<void>

Const signOut

  • signOut(): Promise<void>

Generated using TypeDoc