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

## Type Aliases

### InputType

```ts check=false reason="Generated API signature"
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:44](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L44)

***

### LoginInfo

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

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:73](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L73)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clientid"></a> `clientId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:74](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L74) |
| <a id="clientname"></a> `clientName` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:76](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L76) |
| <a id="clienturi"></a> `clientUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:84](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L84) |
| <a id="logouri"></a> `logoUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:82](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L82) |
| <a id="metadata"></a> `metadata?` | `Record`\<`string`, `any`\> \| `null` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:86](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L86) |
| <a id="policyuri"></a> `policyUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:80](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L80) |
| <a id="tosuri"></a> `tosUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:78](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L78) |

***

### NormalisedInputType

```ts check=false reason="Generated API signature"
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L46)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:47](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L47) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L48) |

***

### PostAPIHookContext

```ts check=false reason="Generated API signature"
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:33](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L33)

***

### 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: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L27)

***

### PreAPIHookContext

```ts check=false reason="Generated API signature"
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:32](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L32)

***

### RecipeInterface

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

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:55](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L55)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getloginchallengeinfo"></a> `getLoginChallengeInfo` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `info`: [`LoginInfo`](#logininfo); `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:56](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L56) |
| <a id="getredirecturltocontinueoauthflow"></a> `getRedirectURLToContinueOAuthFlow` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `frontendRedirectTo`: `string`; `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:61](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L61) |
| <a id="logout"></a> `logOut` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `frontendRedirectTo`: `string`; `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:66](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L66) |

***

### UserInput

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

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:35](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L35)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:36](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L36) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:37](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L37) |