OAuth Provider Types

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/oauth2provider/types.ts:97

Properties

Property	Type	Defined in
OAuth2LogoutScreenInner_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/oauth2provider/types.ts:98

ContinueOAuth2AfterRefreshRedirectContext

type ContinueOAuth2AfterRefreshRedirectContext = object;

Defined in: recipe/oauth2provider/types.ts:65

Properties

Property	Type	Defined in
action	"CONTINUE_OAUTH2_AFTER_REFRESH"	recipe/oauth2provider/types.ts:67
frontendRedirectTo	string	recipe/oauth2provider/types.ts:68
recipeId	"oauth2provider"	recipe/oauth2provider/types.ts:66

GetRedirectionURLContext

type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | SuccessRedirectContextOAuth2
  | ContinueOAuth2AfterRefreshRedirectContext
| PostOAuth2LogoutRedirectContext>;

Defined in: recipe/oauth2provider/types.ts:77

NormalisedConfig

type NormalisedConfig = NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext> & object;

Defined in: recipe/oauth2provider/types.ts:40

Type Declaration

Name	Type	Defined in
disableDefaultUI	boolean	recipe/oauth2provider/types.ts:45
oauth2LogoutScreen	OAuth2LogoutScreenConfig	recipe/oauth2provider/types.ts:46
override	object	recipe/oauth2provider/types.ts:48
override.functions()	(originalImplementation, builder) => SuperTokensWrapper	recipe/oauth2provider/types.ts:49
tryRefreshPage	OAuth2TryRefreshPageConfig	recipe/oauth2provider/types.ts:47

OAuth2LogoutScreenConfig

type OAuth2LogoutScreenConfig = NormalisedBaseConfig & object;

Defined in: recipe/oauth2provider/types.ts:56

Type Declaration

Name	Type	Defined in
disableDefaultUI	boolean	recipe/oauth2provider/types.ts:57

OAuth2LogoutScreenThemeProps

type OAuth2LogoutScreenThemeProps = object;

Defined in: recipe/oauth2provider/types.ts:101

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/oauth2provider/types.ts:102
isLoggingOut	boolean	recipe/oauth2provider/types.ts:103
onLogoutClicked	() => void	recipe/oauth2provider/types.ts:104
showSpinner	boolean	recipe/oauth2provider/types.ts:105

OAuth2TryRefreshPageConfig

type OAuth2TryRefreshPageConfig = object;

Defined in: recipe/oauth2provider/types.ts:61

Properties

Property	Type	Defined in
disableDefaultUI	boolean	recipe/oauth2provider/types.ts:62

OnHandleEventContext

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

PostOAuth2LogoutRedirectContext

type PostOAuth2LogoutRedirectContext = object;

Defined in: recipe/oauth2provider/types.ts:71

Properties

Property	Type	Defined in
action	"POST_OAUTH2_LOGOUT_REDIRECT"	recipe/oauth2provider/types.ts:73
frontendRedirectTo	string	recipe/oauth2provider/types.ts:74
recipeId	"oauth2provider"	recipe/oauth2provider/types.ts:72

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = 
  | "GET_LOGIN_CHALLENGE_INFO"
  | "GET_REDIRECT_URL_TO_CONTINUE_OAUTH_FLOW"
  | "LOG_OUT";

Defined in: recipe/oauth2provider/types.ts:16

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/oauth2provider/types.ts:21

Properties

Property	Type	Defined in
action	PreAndPostAPIHookAction	recipe/oauth2provider/types.ts:22
requestInit	RequestInit	recipe/oauth2provider/types.ts:23
url	string	recipe/oauth2provider/types.ts:24
userContext	UserContext	recipe/oauth2provider/types.ts:25

UserInput

type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/oauth2provider/types.ts:28

Type Declaration

Name	Type	Defined in
disableDefaultUI?	boolean	recipe/oauth2provider/types.ts:29
oauth2LogoutScreen?	Partial<OAuth2LogoutScreenConfig>	recipe/oauth2provider/types.ts:30
override?	object	recipe/oauth2provider/types.ts:32
override.functions()?	(originalImplementation, builder) => SuperTokensWrapper	recipe/oauth2provider/types.ts:33
tryRefreshPage?	Partial<OAuth2TryRefreshPageConfig>	recipe/oauth2provider/types.ts:31