File length: 15870 # References - Frontend SDKs - React SDK Reference - ThirdParty Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-thirdparty ## Classes ### default Defined in: [recipe/thirdparty/index.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L47) #### Constructors ##### Constructor ```ts new default(): default; ``` ###### Returns [`default`](#default) #### Properties | Property | Modifier | Type | Default value | Defined in | | ------ | ------ | ------ | ------ | ------ | | `ActiveDirectory` | `static` | `any` | `ActiveDirectory` | [recipe/thirdparty/index.ts:143](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L143) | | `Apple` | `static` | `any` | `Apple` | [recipe/thirdparty/index.ts:134](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L134) | | `Bitbucket` | `static` | `any` | `Bitbucket` | [recipe/thirdparty/index.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L135) | | `BoxySAML` | `static` | `any` | `BoxySAML` | [recipe/thirdparty/index.ts:144](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L144) | | `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/thirdparty/index.ts:147](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L147) | | `Discord` | `static` | `any` | `Discord` | [recipe/thirdparty/index.ts:136](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L136) | | `Facebook` | `static` | `any` | `Facebook` | [recipe/thirdparty/index.ts:141](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L141) | | `Github` | `static` | `any` | `Github` | [recipe/thirdparty/index.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L137) | | `Gitlab` | `static` | `any` | `Gitlab` | [recipe/thirdparty/index.ts:138](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L138) | | `Google` | `static` | `any` | `Google` | [recipe/thirdparty/index.ts:139](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L139) | | `GoogleWorkspaces` | `static` | `any` | `GoogleWorkspaces` | [recipe/thirdparty/index.ts:140](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L140) | | `LinkedIn` | `static` | `any` | `LinkedIn` | [recipe/thirdparty/index.ts:142](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L142) | | `Okta` | `static` | `any` | `Okta` | [recipe/thirdparty/index.ts:145](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L145) | | `Twitter` | `static` | `any` | `Twitter` | [recipe/thirdparty/index.ts:146](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L146) | #### Methods ##### getAuthorisationURLWithQueryParamsAndSetState() ```ts static getAuthorisationURLWithQueryParamsAndSetState(input): Promise; ``` Defined in: [recipe/thirdparty/index.ts:87](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L87) ###### Parameters | Parameter | Type | | ------ | ------ | | `input` | \{ `frontendRedirectURI`: `string`; `options?`: `RecipeFunctionOptions`; `redirectURIOnProviderDashboard?`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.frontendRedirectURI` | `string` | | `input.options?` | `RecipeFunctionOptions` | | `input.redirectURIOnProviderDashboard?` | `string` | | `input.shouldTryLinkingWithSessionUser?` | `boolean` | | `input.thirdPartyId` | `string` | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | ###### Returns `Promise`\<`string`\> ##### getProviders() ```ts static getProviders(): object[]; ``` Defined in: [recipe/thirdparty/index.ts:124](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L124) ###### Returns `object`[] ##### getStateAndOtherInfoFromStorage() ```ts static getStateAndOtherInfoFromStorage(input?): any; ``` Defined in: [recipe/thirdparty/index.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L78) ###### Type Parameters | Type Parameter | | ------ | | `CustomStateProperties` | ###### Parameters | Parameter | Type | | ------ | ------ | | `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | ###### Returns `any` ##### init() ```ts static init(config?): any; ``` Defined in: [recipe/thirdparty/index.ts:52](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L52) ###### Parameters | Parameter | Type | | ------ | ------ | | `config?` | [`UserInput`](recipe-thirdparty-types.mdx#userinput) | ###### Returns `any` ##### redirectToThirdPartyLogin() ```ts static redirectToThirdPartyLogin(input): Promise<{ status: "OK" | "ERROR"; }>; ``` Defined in: [recipe/thirdparty/index.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L62) ###### Parameters | Parameter | Type | | ------ | ------ | | `input` | \{ `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.shouldTryLinkingWithSessionUser?` | `boolean` | | `input.thirdPartyId` | `string` | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | ###### Returns `Promise`\<\{ `status`: `"OK"` \| `"ERROR"`; \}\> ##### signInAndUp() ```ts 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:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L101) ###### Parameters | Parameter | Type | | ------ | ------ | | `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.options?` | `RecipeFunctionOptions` | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | ###### 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() ```ts static signOut(input?): Promise; ``` Defined in: [recipe/thirdparty/index.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L56) ###### Parameters | Parameter | Type | | ------ | ------ | | `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | ###### Returns `Promise`\<`void`\> ## Variables ### getAuthorisationURLWithQueryParamsAndSetState() ```ts const getAuthorisationURLWithQueryParamsAndSetState: (input) => Promise = Wrapper.getAuthorisationURLWithQueryParamsAndSetState; ``` Defined in: [recipe/thirdparty/index.ts:154](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L154) #### Parameters | Parameter | Type | | ------ | ------ | | `input` | \{ `frontendRedirectURI`: `string`; `options?`: `RecipeFunctionOptions`; `redirectURIOnProviderDashboard?`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.frontendRedirectURI` | `string` | | `input.options?` | `RecipeFunctionOptions` | | `input.redirectURIOnProviderDashboard?` | `string` | | `input.shouldTryLinkingWithSessionUser?` | `boolean` | | `input.thirdPartyId` | `string` | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | #### Returns `Promise`\<`string`\> *** ### getProviders() ```ts const getProviders: () => object[] = Wrapper.getProviders; ``` Defined in: [recipe/thirdparty/index.ts:156](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L156) #### Returns `object`[] *** ### getStateAndOtherInfoFromStorage() ```ts const getStateAndOtherInfoFromStorage: (input?) => any = Wrapper.getStateAndOtherInfoFromStorage; ``` Defined in: [recipe/thirdparty/index.ts:153](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L153) #### Type Parameters | Type Parameter | | ------ | | `CustomStateProperties` | #### Parameters | Parameter | Type | | ------ | ------ | | `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | #### Returns `any` *** ### init() ```ts const init: (config?) => any = Wrapper.init; ``` Defined in: [recipe/thirdparty/index.ts:150](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L150) #### Parameters | Parameter | Type | | ------ | ------ | | `config?` | [`UserInput`](recipe-thirdparty-types.mdx#userinput) | #### Returns `any` *** ### redirectToThirdPartyLogin() ```ts const redirectToThirdPartyLogin: (input) => Promise<{ status: "OK" | "ERROR"; }> = Wrapper.redirectToThirdPartyLogin; ``` Defined in: [recipe/thirdparty/index.ts:152](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L152) #### Parameters | Parameter | Type | | ------ | ------ | | `input` | \{ `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.shouldTryLinkingWithSessionUser?` | `boolean` | | `input.thirdPartyId` | `string` | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | #### Returns `Promise`\<\{ `status`: `"OK"` \| `"ERROR"`; \}\> *** ### signInAndUp() ```ts 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:155](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L155) #### Parameters | Parameter | Type | | ------ | ------ | | `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.options?` | `RecipeFunctionOptions` | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | #### 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() ```ts const signOut: (input?) => Promise = Wrapper.signOut; ``` Defined in: [recipe/thirdparty/index.ts:151](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L151) #### Parameters | Parameter | Type | | ------ | ------ | | `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} | | `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) | #### Returns `Promise`\<`void`\> *** ### ThirdpartyComponentsOverrideProvider ```ts const ThirdpartyComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider; ``` Defined in: [recipe/thirdparty/index.ts:157](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L157) ## References ### ActiveDirectory Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Apple Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Bitbucket Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### BoxySAML Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Discord Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Facebook Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### GetRedirectionURLContext Re-exports [GetRedirectionURLContext](recipe-thirdparty-types.mdx#getredirectionurlcontext) *** ### Github Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Gitlab Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Google Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### GoogleWorkspaces Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### LinkedIn Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Okta Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### OnHandleEventContext Re-exports [OnHandleEventContext](recipe-thirdparty-types.mdx#onhandleeventcontext) *** ### PreAPIHookContext Re-exports [PreAPIHookContext](recipe-thirdparty-types.mdx#preapihookcontext) *** ### RecipeInterface Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### Twitter Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1) *** ### UserInput Re-exports [UserInput](recipe-thirdparty-types.mdx#userinput)