supertokens-web-js/recipe/oauth2provider/types
References documentation for the supertokens-web-js/recipe/oauth2provider/types package
Type Aliases
InputType
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;Defined in: tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts
LoginInfo
type LoginInfo = object;Defined in: tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts
Properties
| Property | Type | Defined in |
|---|---|---|
clientId |
string |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
clientName |
string |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
clientUri? |
string |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
logoUri? |
string |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
metadata? |
Record<string, any> | null |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
policyUri? |
string |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
tosUri? |
string |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
NormalisedInputType
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;Defined in: tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts
Type Declaration
| Name | Type | Defined in |
|---|---|---|
override |
object |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
override.functions() |
(originalImplementation, builder) => RecipeInterface |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
PostAPIHookContext
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;Defined in: tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts
PreAndPostAPIHookAction
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
PreAPIHookContext
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;Defined in: tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts
RecipeInterface
type RecipeInterface = object;Defined in: tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts
Properties
| Property | Type | Defined in |
|---|---|---|
getLoginChallengeInfo |
(input) => Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK"; }> |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
getRedirectURLToContinueOAuthFlow |
(input) => Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK"; }> |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
logOut |
(input) => Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK"; }> |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
UserInput
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;Defined in: tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts
Type Declaration
| Name | Type | Defined in |
|---|---|---|
override? |
object |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |
override.functions()? |
(originalImplementation, builder) => RecipeInterface |
tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts |