Class OAuth2Strategy<User>

constructor

• new OAuth2Strategy<User>(
      options: ConstructorOptions,
      verify: VerifyFunction<User, VerifyOptions>,
  ): OAuth2Strategy<User>

  Type Parameters

  • User

  Parameters

  • options: ConstructorOptions
  • verify: VerifyFunction<User, VerifyOptions>

  Returns OAuth2Strategy<User>

name

authenticate

• authenticate(request: Request): Promise<User>

  The authentication flow of the strategy.

  This method receives the Request from the authenticator we want to authenticate.

  At the end of the flow, it will return a the User data to be used by the application.

  Parameters

  • request: Request

  Returns Promise<User>

refreshToken

• refreshToken(refreshToken: string): Promise<OAuth2Tokens>

  Get a new OAuth2 Tokens object using the refresh token once the previous access token has expired.

  Parameters

  • refreshToken: string

    The refresh token to use to get a new access token

  Returns Promise<OAuth2Tokens>

  The new OAuth2 tokens object

  Example

  let tokens = await strategy.refreshToken(refreshToken);
  console.log(tokens.accessToken());
  Copy

revokeToken

• revokeToken(token: string): Promise<void>

  Users the token revocation endpoint of the identity provider to revoke the access token and make it invalid.

  Parameters

  • token: string

    The access token to revoke

  Returns Promise<void>

  Example

  // Get it from where you stored it
  let accessToken = await getAccessToken();
  await strategy.revokeToken(tokens.access_token);
  Copy

Staticdiscover

• discover<U, M extends OAuth2Strategy<U> = OAuth2Strategy<U>>(
      this: new (
          options: ConstructorOptions,
          verify: VerifyFunction<U, VerifyOptions>,
      ) => M,
      uri: string | URL,
      options: Pick<
          ConstructorOptions,
          "cookie"
          | "clientId"
          | "clientSecret"
          | "redirectURI"
          | "scopes",
      > & Partial<
          Omit<
              ConstructorOptions,
              "cookie"
              | "clientId"
              | "clientSecret"
              | "redirectURI"
              | "scopes",
          >,
      >,
      verify: VerifyFunction<U, VerifyOptions>,
  ): Promise<M>

  Discover the OAuth2 issuer and create a new OAuth2Strategy instance from the OIDC configuration that is returned.

  This method will fetch the OIDC configuration from the issuer and create a new OAuth2Strategy instance with the provided options and verify function.

  Type Parameters

  • U
  • M extends OAuth2Strategy<U> = OAuth2Strategy<U>

  Parameters

  • this: new (options: ConstructorOptions, verify: VerifyFunction<U, VerifyOptions>) => M
  • uri: string | URL

    The URI of the issuer, this can be a full URL or just the domain
  • options: Pick<
        ConstructorOptions,
        "cookie"
        | "clientId"
        | "clientSecret"
        | "redirectURI"
        | "scopes",
    > & Partial<
        Omit<
            ConstructorOptions,
            "cookie"
            | "clientId"
            | "clientSecret"
            | "redirectURI"
            | "scopes",
        >,
    >

    The rest of the options to pass to the OAuth2Strategy constructor, clientId, clientSecret, redirectURI, and scopes are required.
  • verify: VerifyFunction<U, VerifyOptions>

    The verify function to use with the OAuth2Strategy instance

  Returns Promise<M>

  A new OAuth2Strategy instance

  Example

  let strategy = await OAuth2Strategy.discover(
    "https://accounts.google.com",
    {
      clientId: "your-client-id",
      clientSecret: "your-client-secret",
      redirectURI: "https://your-app.com/auth/callback",
      scopes: ["openid", "email", "profile"],
    },
    async ({ tokens }) => {
      return getUserProfile(tokens.access_token);
    },
  
  Copy