Skip to content
SuperTokens Docs
Esc
↑↓navigate↵open⌘Jpreview
Dashboard
On this page

supertokens-auth-react/recipe/thirdparty

References documentation for the supertokens-auth-react/recipe/thirdparty package

Classes

default

Defined in: recipe/thirdparty/index.ts

Constructors

Constructor
new default(): default;
Returns

default

Properties

Property Modifier Type Default value Defined in
ActiveDirectory static any ActiveDirectory recipe/thirdparty/index.ts
Apple static any Apple recipe/thirdparty/index.ts
Bitbucket static any Bitbucket recipe/thirdparty/index.ts
BoxySAML static any BoxySAML recipe/thirdparty/index.ts
ComponentsOverrideProvider static any RecipeComponentsOverrideContextProvider recipe/thirdparty/index.ts
Discord static any Discord recipe/thirdparty/index.ts
Facebook static any Facebook recipe/thirdparty/index.ts
Github static any Github recipe/thirdparty/index.ts
Gitlab static any Gitlab recipe/thirdparty/index.ts
Google static any Google recipe/thirdparty/index.ts
GoogleWorkspaces static any GoogleWorkspaces recipe/thirdparty/index.ts
LinkedIn static any LinkedIn recipe/thirdparty/index.ts
Okta static any Okta recipe/thirdparty/index.ts
Twitter static any Twitter recipe/thirdparty/index.ts

Methods

getAuthorisationURLWithQueryParamsAndSetState()
static getAuthorisationURLWithQueryParamsAndSetState(input): Promise<string>;

Defined in: recipe/thirdparty/index.ts

Parameters
Parameter Type
input { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; shouldTryLinkingWithSessionUser?: boolean; thirdPartyId: string; userContext?: UserContext; }
input.frontendRedirectURI string
input.options? RecipeFunctionOptions
input.redirectURIOnProviderDashboard? string
input.shouldTryLinkingWithSessionUser? boolean
input.thirdPartyId string
input.userContext? UserContext
Returns

Promise<string>

getProviders()
static getProviders(): object[];

Defined in: recipe/thirdparty/index.ts

Returns

object[]

getStateAndOtherInfoFromStorage()
static getStateAndOtherInfoFromStorage<CustomStateProperties>(input?): any;

Defined in: recipe/thirdparty/index.ts

Type Parameters
Type Parameter
CustomStateProperties
Parameters
Parameter Type
input? { userContext?: UserContext; }
input.userContext? UserContext
Returns

any

init()
static init(config?): any;

Defined in: recipe/thirdparty/index.ts

Parameters
Parameter Type
config? UserInput
Returns

any

redirectToThirdPartyLogin()
static redirectToThirdPartyLogin(input): Promise<{
  status: "OK" | "ERROR";
}>;

Defined in: recipe/thirdparty/index.ts

Parameters
Parameter Type
input { shouldTryLinkingWithSessionUser?: boolean; thirdPartyId: string; userContext?: UserContext; }
input.shouldTryLinkingWithSessionUser? boolean
input.thirdPartyId string
input.userContext? UserContext
Returns

Promise<{ status: "OK" | "ERROR"; }>

signInAndUp()
static signInAndUp(input?): Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "NO_EMAIL_GIVEN_BY_PROVIDER";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;

Defined in: recipe/thirdparty/index.ts

Parameters
Parameter Type
input? { options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options? RecipeFunctionOptions
input.userContext? UserContext
Returns

Promise< | { createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User; } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER"; } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED"; }>

signOut()
static signOut(input?): Promise<void>;

Defined in: recipe/thirdparty/index.ts

Parameters
Parameter Type
input? { userContext?: UserContext; }
input.userContext? UserContext
Returns

Promise<void>

Variables

getAuthorisationURLWithQueryParamsAndSetState()

const getAuthorisationURLWithQueryParamsAndSetState: (input) => Promise<string> = Wrapper.getAuthorisationURLWithQueryParamsAndSetState;

Defined in: recipe/thirdparty/index.ts

Parameters

Parameter Type
input { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; shouldTryLinkingWithSessionUser?: boolean; thirdPartyId: string; userContext?: UserContext; }
input.frontendRedirectURI string
input.options? RecipeFunctionOptions
input.redirectURIOnProviderDashboard? string
input.shouldTryLinkingWithSessionUser? boolean
input.thirdPartyId string
input.userContext? UserContext

Returns

Promise<string>

getProviders()

const getProviders: () => object[] = Wrapper.getProviders;

Defined in: recipe/thirdparty/index.ts

Returns

object[]

getStateAndOtherInfoFromStorage()

const getStateAndOtherInfoFromStorage: <CustomStateProperties>(input?) => any = Wrapper.getStateAndOtherInfoFromStorage;

Defined in: recipe/thirdparty/index.ts

Type Parameters

Type Parameter
CustomStateProperties

Parameters

Parameter Type
input? { userContext?: UserContext; }
input.userContext? UserContext

Returns

any

init()

const init: (config?) => any = Wrapper.init;

Defined in: recipe/thirdparty/index.ts

Parameters

Parameter Type
config? UserInput

Returns

any

redirectToThirdPartyLogin()

const redirectToThirdPartyLogin: (input) => Promise<{
  status: "OK" | "ERROR";
}> = Wrapper.redirectToThirdPartyLogin;

Defined in: recipe/thirdparty/index.ts

Parameters

Parameter Type
input { shouldTryLinkingWithSessionUser?: boolean; thirdPartyId: string; userContext?: UserContext; }
input.shouldTryLinkingWithSessionUser? boolean
input.thirdPartyId string
input.userContext? UserContext

Returns

Promise<{ status: "OK" | "ERROR"; }>

signInAndUp()

const signInAndUp: (input?) => Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "NO_EMAIL_GIVEN_BY_PROVIDER";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}> = Wrapper.signInAndUp;

Defined in: recipe/thirdparty/index.ts

Parameters

Parameter Type
input? { options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options? RecipeFunctionOptions
input.userContext? UserContext

Returns

Promise< | { createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User; } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER"; } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED"; }>

signOut()

const signOut: (input?) => Promise<void> = Wrapper.signOut;

Defined in: recipe/thirdparty/index.ts

Parameters

Parameter Type
input? { userContext?: UserContext; }
input.userContext? UserContext

Returns

Promise<void>

ThirdpartyComponentsOverrideProvider

const ThirdpartyComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;

Defined in: recipe/thirdparty/index.ts

References

ActiveDirectory

Renames and re-exports SuperTokensWrapper

Apple

Renames and re-exports SuperTokensWrapper

Bitbucket

Renames and re-exports SuperTokensWrapper

BoxySAML

Renames and re-exports SuperTokensWrapper

Discord

Renames and re-exports SuperTokensWrapper

Facebook

Renames and re-exports SuperTokensWrapper

GetRedirectionURLContext

Re-exports GetRedirectionURLContext

Github

Renames and re-exports SuperTokensWrapper

Gitlab

Renames and re-exports SuperTokensWrapper

Google

Renames and re-exports SuperTokensWrapper

GoogleWorkspaces

Renames and re-exports SuperTokensWrapper

LinkedIn

Renames and re-exports SuperTokensWrapper

Okta

Renames and re-exports SuperTokensWrapper

OnHandleEventContext

Re-exports OnHandleEventContext

PreAPIHookContext

Re-exports PreAPIHookContext

RecipeInterface

Renames and re-exports SuperTokensWrapper

Twitter

Renames and re-exports SuperTokensWrapper

UserInput

Re-exports UserInput

API reference

API schema and response details