Class OAuth2Strategy<User, Profile, ExtraParams>

Type Parameters

User
Profile extends OAuth2Profile
ExtraParams extends Record<string, unknown> = Record<string, never>

Hierarchy

Strategy<User, OAuth2StrategyVerifyParams<Profile, ExtraParams>>
- OAuth2Strategy

Index

Constructors

constructor

new OAuth2Strategy<User, Profile, ExtraParams>(options, verify): OAuth2Strategy<User, Profile, ExtraParams>
Type Parameters
- User
- Profile extends OAuth2Profile
- ExtraParams extends Record<string, unknown> = Record<string, never>
Parameters
- options: OAuth2StrategyOptions
- verify: StrategyVerifyCallback<User, OAuth2StrategyVerifyParams<Profile, ExtraParams>>
Returns OAuth2Strategy<User, Profile, ExtraParams>
Overrides Strategy<User, OAuth2StrategyVerifyParams<Profile, ExtraParams>>.constructor
- Defined in src/index.ts:115

Properties

name

name: string = "oauth2"

The name of the strategy. This will be used by the Authenticator to identify and retrieve the strategy.

`Protected`options

options: OAuth2StrategyOptions

`Protected`sessionCodeVerifierKey

sessionCodeVerifierKey: string = "oauth2:codeVerifier"

`Protected`sessionStateKey

sessionStateKey: string = "oauth2:state"

`Protected`verify

verify: StrategyVerifyCallback<User, OAuth2StrategyVerifyParams<Profile, ExtraParams>>

Methods

authenticate

authenticate(request, sessionStorage, options): Promise<User>
The authentication flow of the strategy.

This method receives the Request to authenticator and the session storage to use from the Authenticator. It may receive a custom callback.

At the end of the flow, it will return a Response to be used by the application.
Parameters
- request: Request
- sessionStorage: SessionStorage<SessionData, SessionData>
- options: AuthenticateOptions
Returns Promise<User>
Overrides Strategy.authenticate
- Defined in src/index.ts:130

`Protected`authorizationParams

authorizationParams(params, request): URLSearchParams
Return extra parameters to be included in the authorization request.

Some OAuth 2.0 providers allow additional, non-standard parameters to be included when requesting authorization. Since these parameters are not standardized by the OAuth 2.0 specification, OAuth 2.0-based authentication strategies can override this function in order to populate these parameters as required by the provider.
Parameters
- params: URLSearchParams
- request: Request
Returns URLSearchParams
- Defined in src/index.ts:342

`Protected`failure

failure(message, request, sessionStorage, options, cause?): Promise<never>
Throw an AuthorizationError or a redirect to the failureRedirect.
Parameters
- message: string
  The error message to set in the session.
- request: Request
  The request to get the cookie out of.
- sessionStorage: SessionStorage<SessionData, SessionData>
  The session storage to retrieve the session from.
- options: AuthenticateOptions
  The strategy options.
- Optionalcause: Error
Returns Promise<never>
Throws
If the throwOnError is set to true.

Throws
If the failureRedirect is set or throwOnError is false.
Inherited from Strategy.failure
- Defined in node_modules/remix-auth/build/strategy.d.ts:99

refreshToken

refreshToken(refreshToken, options?): Promise<Body & ExtraParams>
Get new tokens using a refresh token.
Parameters
- refreshToken: string
  The refresh token to use
- options: Partial<Pick<OAuth2StrategyOptions, "scopes">> & {
  signal?: AbortSignal;
  } = {}
  Optional options to override the default strategy options
Returns Promise<Body & ExtraParams>
A promise that resolves to the new tokens
- Defined in src/index.ts:355

revokeToken

revokeToken(token, options?): Promise<void>
Parameters
- token: string
- options: {
  signal?: AbortSignal;
  tokenType?: "access_token" | "refresh_token";
  } = {}
  - Optionalsignal?: AbortSignal
  - OptionaltokenType?: "access_token" | "refresh_token"
Returns Promise<void>
- Defined in src/index.ts:386

`Protected`success

success(user, request, sessionStorage, options): Promise<User>
Returns the user data or throw a redirect to the successRedirect.
Parameters
- user: User
  The user data to set in the session.
- request: Request
  The request to get the cookie out of.
- sessionStorage: SessionStorage<SessionData, SessionData>
  The session storage to retrieve the session from.
- options: AuthenticateOptions
  The strategy options.
Returns Promise<User>
The user data.

Throws
If the successRedirect is set, it will redirect to it.
Inherited from Strategy.success
- Defined in node_modules/remix-auth/build/strategy.d.ts:109

`Protected`userProfile

userProfile(tokens): Promise<Profile>
Parameters
- tokens: Body
Returns Promise<Profile>
- Defined in src/index.ts:329

Class OAuth2Strategy<User, Profile, ExtraParams>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OAuth2Strategy<User, Profile, ExtraParams>

Properties

name

Protectedoptions

ProtectedsessionCodeVerifierKey

ProtectedsessionStateKey

Protectedverify

Methods

authenticate

Parameters

Returns Promise<User>

ProtectedauthorizationParams

Parameters

Returns URLSearchParams

Protectedfailure

Parameters

Returns Promise<never>

Throws

Throws

refreshToken

Parameters

Returns Promise<Body & ExtraParams>

revokeToken

Parameters

Optionalsignal?: AbortSignal

OptionaltokenType?: "access_token" | "refresh_token"

Returns Promise<void>

Protectedsuccess

Parameters

Returns Promise<User>

Throws

ProtecteduserProfile

Parameters

Returns Promise<Profile>

Settings

On This Page

`Protected`options

`Protected`sessionCodeVerifierKey

`Protected`sessionStateKey

`Protected`verify

`Protected`authorizationParams

`Protected`failure

`Optional`signal?: AbortSignal

`Optional`tokenType?: "access_token" | "refresh_token"

`Protected`success

`Protected`userProfile