---
title: supertokens-auth-react/recipe/oauth2provider/types
description: References documentation for the supertokens-auth-react/recipe/oauth2provider/types package
sidebar:
  order: 120
---

## Type Aliases

### ComponentOverrideMap

```ts check=false reason="Generated API signature"
type ComponentOverrideMap = object;
```

Defined in: [recipe/oauth2provider/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L97)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="oauth2logoutscreeninner_override"></a> `OAuth2LogoutScreenInner_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index#supertokenswrapper-1)\> | [recipe/oauth2provider/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L98) |

***

### ContinueOAuth2AfterRefreshRedirectContext

```ts check=false reason="Generated API signature"
type ContinueOAuth2AfterRefreshRedirectContext = object;
```

Defined in: [recipe/oauth2provider/types.ts:65](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L65)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | `"CONTINUE_OAUTH2_AFTER_REFRESH"` | [recipe/oauth2provider/types.ts:67](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L67) |
| <a id="frontendredirectto"></a> `frontendRedirectTo` | `string` | [recipe/oauth2provider/types.ts:68](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L68) |
| <a id="recipeid"></a> `recipeId` | `"oauth2provider"` | [recipe/oauth2provider/types.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L66) |

***

### GetRedirectionURLContext

```ts check=false reason="Generated API signature"
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | SuccessRedirectContextOAuth2
  | ContinueOAuth2AfterRefreshRedirectContext
| PostOAuth2LogoutRedirectContext>;
```

Defined in: [recipe/oauth2provider/types.ts:77](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L77)

***

### NormalisedConfig

```ts check=false reason="Generated API signature"
type NormalisedConfig = NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext> & object;
```

Defined in: [recipe/oauth2provider/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L40)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/oauth2provider/types.ts:45](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L45) |
| `oauth2LogoutScreen` | [`OAuth2LogoutScreenConfig`](#oauth2logoutscreenconfig) | [recipe/oauth2provider/types.ts:46](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L46) |
| `override` | `object` | [recipe/oauth2provider/types.ts:48](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L48) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index#supertokenswrapper-1) | [recipe/oauth2provider/types.ts:49](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L49) |
| `tryRefreshPage` | [`OAuth2TryRefreshPageConfig`](#oauth2tryrefreshpageconfig) | [recipe/oauth2provider/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L47) |

***

### OAuth2LogoutScreenConfig

```ts check=false reason="Generated API signature"
type OAuth2LogoutScreenConfig = NormalisedBaseConfig & object;
```

Defined in: [recipe/oauth2provider/types.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L56)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/oauth2provider/types.ts:57](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L57) |

***

### OAuth2LogoutScreenThemeProps

```ts check=false reason="Generated API signature"
type OAuth2LogoutScreenThemeProps = object;
```

Defined in: [recipe/oauth2provider/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L101)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/oauth2provider/types.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L102) |
| <a id="isloggingout"></a> `isLoggingOut` | `boolean` | [recipe/oauth2provider/types.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L103) |
| <a id="onlogoutclicked"></a> `onLogoutClicked` | () => `void` | [recipe/oauth2provider/types.ts:104](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L104) |
| <a id="showspinner"></a> `showSpinner` | `boolean` | [recipe/oauth2provider/types.ts:105](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L105) |

***

### OAuth2TryRefreshPageConfig

```ts check=false reason="Generated API signature"
type OAuth2TryRefreshPageConfig = object;
```

Defined in: [recipe/oauth2provider/types.ts:61](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L61)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="disabledefaultui"></a> `disableDefaultUI` | `boolean` | [recipe/oauth2provider/types.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L62) |

***

### OnHandleEventContext

```ts check=false reason="Generated API signature"
type OnHandleEventContext = 
  | {
  action: "LOADED_LOGIN_CHALLENGE";
  loginChallenge: string;
  loginInfo: SuperTokensWrapper;
  userContext: UserContext;
}
  | {
  action: "OAUTH2_LOGOUT_SUCCESS";
  frontendRedirectTo: string;
  userContext: UserContext;
};
```

Defined in: [recipe/oauth2provider/types.ts:81](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L81)

***

### PostOAuth2LogoutRedirectContext

```ts check=false reason="Generated API signature"
type PostOAuth2LogoutRedirectContext = object;
```

Defined in: [recipe/oauth2provider/types.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L71)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-1"></a> `action` | `"POST_OAUTH2_LOGOUT_REDIRECT"` | [recipe/oauth2provider/types.ts:73](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L73) |
| <a id="frontendredirectto-1"></a> `frontendRedirectTo` | `string` | [recipe/oauth2provider/types.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L74) |
| <a id="recipeid-1"></a> `recipeId` | `"oauth2provider"` | [recipe/oauth2provider/types.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L72) |

***

### PreAndPostAPIHookAction

```ts check=false reason="Generated API signature"
type PreAndPostAPIHookAction = 
  | "GET_LOGIN_CHALLENGE_INFO"
  | "GET_REDIRECT_URL_TO_CONTINUE_OAUTH_FLOW"
  | "LOG_OUT";
```

Defined in: [recipe/oauth2provider/types.ts:16](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L16)

***

### PreAPIHookContext

```ts check=false reason="Generated API signature"
type PreAPIHookContext = object;
```

Defined in: [recipe/oauth2provider/types.ts:21](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L21)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-2"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/oauth2provider/types.ts:22](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L22) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/oauth2provider/types.ts:23](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L23) |
| <a id="url"></a> `url` | `string` | [recipe/oauth2provider/types.ts:24](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L24) |
| <a id="usercontext"></a> `userContext` | [`UserContext`](types#usercontext) | [recipe/oauth2provider/types.ts:25](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L25) |

***

### UserInput

```ts check=false reason="Generated API signature"
type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/oauth2provider/types.ts:28](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L28)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/oauth2provider/types.ts:29](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L29) |
| `oauth2LogoutScreen?` | `Partial`\<[`OAuth2LogoutScreenConfig`](#oauth2logoutscreenconfig)\> | [recipe/oauth2provider/types.ts:30](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L30) |
| `override?` | `object` | [recipe/oauth2provider/types.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L32) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index#supertokenswrapper-1) | [recipe/oauth2provider/types.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L33) |
| `tryRefreshPage?` | `Partial`\<[`OAuth2TryRefreshPageConfig`](#oauth2tryrefreshpageconfig)\> | [recipe/oauth2provider/types.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L31) |