recipe/oauth2provider | supertokens-web-js

Index

References

RecipeFunctionOptions

Classes

default

Type Aliases

Functions

References

RecipeFunctionOptions

Re-exports RecipeFunctionOptions

Type Aliases

LoginInfo

LoginInfo: { clientId: string; clientName: string; clientUri?: string; logoUri?: string; metadata?: Record<string, any> | null; policyUri?: string; tosUri?: string }

Type declaration

clientId: string
clientName: string
Optional clientUri?: string
Optional logoUri?: string
Optional metadata?: Record<string, any> | null
Optional policyUri?: string
Optional tosUri?: string

PostAPIHookContext

PostAPIHookContext: RecipePostAPIHookContext<PreAndPostAPIHookAction>

PreAPIHookContext

PreAPIHookContext: RecipePreAPIHookContext<PreAndPostAPIHookAction>

PreAndPostAPIHookAction

PreAndPostAPIHookAction: "GET_LOGIN_CHALLENGE_INFO" | "GET_REDIRECT_URL_TO_CONTINUE_OAUTH_FLOW" | "LOG_OUT"

RecipeInterface

RecipeInterface: { getLoginChallengeInfo: any; getRedirectURLToContinueOAuthFlow: any; logOut: any }

Type declaration

getLoginChallengeInfo:function
- getLoginChallengeInfo(input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext: any }): Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>
- - Defined in lib/ts/recipe/oauth2provider/types.ts:56
  Parameters
  - input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext: any }
    - loginChallenge: string
    - Optional options?: RecipeFunctionOptions
    - userContext: any
  Returns Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>
getRedirectURLToContinueOAuthFlow:function
- getRedirectURLToContinueOAuthFlow(input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext: any }): Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>
- - Defined in lib/ts/recipe/oauth2provider/types.ts:61
  Parameters
  - input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext: any }
    - loginChallenge: string
    - Optional options?: RecipeFunctionOptions
    - userContext: any
  Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>
logOut:function
- logOut(input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext: any }): Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>
- - Defined in lib/ts/recipe/oauth2provider/types.ts:66
  Parameters
  - input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext: any }
    - logoutChallenge: string
    - Optional options?: RecipeFunctionOptions
    - userContext: any
  Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

UserInput

UserInput: { override?: { functions?: any } } & RecipeModuleUserInput<PreAndPostAPIHookAction>

Functions

getLoginChallengeInfo

getLoginChallengeInfo(input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>

- Defined in lib/ts/recipe/oauth2provider/index.ts:115
Parameters
- input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }
  - loginChallenge: string
  - Optional options?: RecipeFunctionOptions
  - Optional userContext?: any
Returns Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>

getRedirectURLToContinueOAuthFlow

getRedirectURLToContinueOAuthFlow(input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

- Defined in lib/ts/recipe/oauth2provider/index.ts:116
Parameters
- input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }
  - loginChallenge: string
  - Optional options?: RecipeFunctionOptions
  - Optional userContext?: any
Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

init

init(config?: UserInput): CreateRecipeFunction<PreAndPostAPIHookAction>

- Defined in lib/ts/recipe/oauth2provider/index.ts:114
Parameters
- Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>

logOut

logOut(input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

- Defined in lib/ts/recipe/oauth2provider/index.ts:117
Parameters
- input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext?: any }
  - logoutChallenge: string
  - Optional options?: RecipeFunctionOptions
  - Optional userContext?: any
Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

Index

References

Classes

Type Aliases

Functions

References

RecipeFunctionOptions

Type Aliases

LoginInfo

Type declaration

clientId: string

clientName: string

Optional clientUri?: string

Optional logoUri?: string

Optional metadata?: Record<string, any> | null

Optional policyUri?: string

Optional tosUri?: string

PostAPIHookContext

PreAPIHookContext

PreAndPostAPIHookAction

RecipeInterface

Type declaration

getLoginChallengeInfo:function

Parameters

input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext: any }

loginChallenge: string

Optional options?: RecipeFunctionOptions

userContext: any

Returns Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>

getRedirectURLToContinueOAuthFlow:function

Parameters

input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext: any }

loginChallenge: string

Optional options?: RecipeFunctionOptions

userContext: any

Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

logOut:function

Parameters

input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext: any }

logoutChallenge: string

Optional options?: RecipeFunctionOptions

userContext: any

Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

UserInput

Functions

getLoginChallengeInfo

Parameters

input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }

loginChallenge: string

Optional options?: RecipeFunctionOptions

Optional userContext?: any

Returns Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>

getRedirectURLToContinueOAuthFlow

Parameters

input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }

loginChallenge: string

Optional options?: RecipeFunctionOptions

Optional userContext?: any

Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

init

Parameters

Optional config: UserInput

Returns CreateRecipeFunction<PreAndPostAPIHookAction>

logOut

Parameters

input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext?: any }

logoutChallenge: string

Optional options?: RecipeFunctionOptions

Optional userContext?: any

Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>