Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@feathersjs/authentication-oauth

feathersjs48kMIT5.0.37TypeScript support: included

oAuth 1 and 2 authentication for Feathers. Powered by Grant.

feathers, feathers-plugin

readme

Feathers - The API and real-time application framework

CI Download Status Discord

Feathers is a full-stack framework for creating web APIs and real-time applications with TypeScript or JavaScript.

Feathers can interact with any backend technology, supports many databases out of the box and works with any frontend like React, VueJS, Angular, React Native, Android or iOS.

Getting started

Get started with just three commands:

$ npm create feathers my-new-app
$ cd my-new-app
$ npm run dev

To learn more about Feathers visit the website at feathersjs.com or jump right into the Feathers guides.

Contributing

To start developing, clone this repository, then run:

cd feathers
npm install

To run all tests run

npm test

Individual tests can be run in the module you are working on:

cd packages/feathers
npm test

License

Copyright (c) 2024 Feathers contributors

Licensed under the MIT license.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.37 (2025-11-10)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.36 (2025-11-08)

Bug Fixes

5.0.35 (2025-09-09)

Bug Fixes

5.0.34 (2025-05-03)

Bug Fixes

5.0.33 (2025-02-24)

Bug Fixes

5.0.32 (2025-02-01)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.31 (2024-10-31)

Bug Fixes

5.0.30 (2024-09-02)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.29 (2024-07-10)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.28 (2024-07-10)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.27 (2024-06-18)

Bug Fixes

  • authentication-oauth: Allow POST oauth callbacks (#3497) (ffcc90b)

5.0.26 (2024-06-09)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.25 (2024-05-03)

Bug Fixes

5.0.24 (2024-03-13)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.23 (2024-02-25)

Bug Fixes

5.0.22 (2024-02-15)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.21 (2024-01-25)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.20 (2024-01-24)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.19 (2024-01-23)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.18 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.17 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.16 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.15 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.14 (2024-01-05)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.13 (2023-12-29)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.12 (2023-11-28)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.11 (2023-10-11)

Bug Fixes

  • knex: Update all dependencies and Knex peer (#3308) (d2f9860)

5.0.10 (2023-10-03)

Bug Fixes

  • authentication-oauth: Move Grant error handling to the correct spot (#3297) (e9c0828)

5.0.9 (2023-09-27)

Bug Fixes

  • authentication-oauth: Properly handle all oAuth errors (#3284) (148a9a3)

5.0.8 (2023-07-19)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.7 (2023-07-14)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.6 (2023-06-15)

Bug Fixes

  • authentication-oauth: Update OAuth redirect to handle user requested redirect paths (#3186) (3742028)

5.0.5 (2023-04-28)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.4 (2023-04-12)

Bug Fixes

  • Make sure all Readme files are up to date (#3154) (a5f0b38)

5.0.3 (2023-04-05)

Bug Fixes

5.0.1 (2023-03-15)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0 (2023-02-24)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.38 (2023-02-17)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.37 (2023-02-09)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.36 (2023-01-29)

Bug Fixes

5.0.0-pre.35 (2023-01-12)

Features

  • generators: Move core code generators to shared generators package (#2982) (0328d22)

5.0.0-pre.34 (2022-12-14)

Bug Fixes

  • core: Improve service option usage and method option typings (#2902) (164d75c)

5.0.0-pre.33 (2022-11-08)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.32 (2022-10-26)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.31 (2022-10-12)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.30 (2022-10-07)

Bug Fixes

  • authentication-oauth: Fix regression with prefix handling in OAuth (#2773) (b1844b1)

Features

  • core: Allow to unregister services at runtime (#2756) (d16601f)

5.0.0-pre.29 (2022-09-16)

Bug Fixes

  • authentication-oauth: Fix oAuth origin and error handling (#2752) (f7e1c33)

Features

  • Add CORS support to oAuth, Express, Koa and generated application (#2744) (fd218f2)
  • authentication-oauth: Koa and transport independent oAuth authentication (#2737) (9231525)

5.0.0-pre.28 (2022-08-03)

Bug Fixes

  • cli: Improve generated application and client (#2701) (bd55ffb)

5.0.0-pre.27 (2022-07-13)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.26 (2022-06-22)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.25 (2022-06-22)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.24 (2022-06-21)

Bug Fixes

  • authentication-oauth: Fix bug and properly set Grant defaults (#2659) (cb93bb9)

Features

  • cli: Add typed client to a generated app (#2669) (5b801b5)

5.0.0-pre.23 (2022-06-06)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.22 (2022-05-24)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.21 (2022-05-23)

Bug Fixes

  • authentication-oauth: Fix regression using incorrect callback and redirect_uri (#2631) (43d8a08)

5.0.0-pre.20 (2022-05-04)

Bug Fixes

  • authentication-oauth: Don't send origins in Grant's config, as it will be considered another provider (#2617) (ae3dddd)
  • dependencies: Lock monorepo package version numbers (#2623) (5640c10)

5.0.0-pre.19 (2022-05-01)

Bug Fixes

  • authentication-oauth: Fix issue with overriding the default Grant configuration (#2615) (b345857)
  • authentication-oauth: Make oAuth authentication work with cookie-session (#2614) (9f10bfc)

Features

  • typescript: Improve params and query typeability (#2600) (df28b76)

5.0.0-pre.18 (2022-04-11)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.17 (2022-02-15)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.16 (2022-01-12)

Bug Fixes

  • authentication-oauth: OAuth redirect lost sometimes due to session store race (#2514) (#2515) (6109c44)

5.0.0-pre.15 (2021-11-27)

Features

  • authentication-oauth: Allow dynamic oAuth redirect (#2469) (b7143d4)

5.0.0-pre.14 (2021-10-13)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.13 (2021-10-13)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.12 (2021-10-12)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.11 (2021-10-06)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.10 (2021-09-19)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.9 (2021-08-09)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.8 (2021-08-09)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.7 (2021-08-09)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.6 (2021-08-08)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.5 (2021-06-23)

Bug Fixes

  • authentication-oauth: Omit query from internal calls (#2398) (04c7c83)
  • koa: Use extended query parser for compatibility (#2397) (b2944ba)

Features

  • adapter-commons: Add support for params.adapter option and move memory adapter to @feathersjs/memory (#2367) (a43e7da)

5.0.0-pre.4 (2021-05-13)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.3 (2021-04-21)

Bug Fixes

  • typescript: Improve TypeScript backwards compatibility (#2310) (f33be73)

Features

  • dependencies: Remove direct debug dependency (#2296) (501d416)

5.0.0-pre.2 (2021-04-06)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-beta.1 (2021-04-03)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-beta.0 (2021-03-28)

Bug Fixes

  • Update Grant usage and other dependencies (#2264) (7b0f8fa)

Features

  • Feathers v5 core refactoring and features (#2255) (2dafb7c)

5.0.0-pre.1 (2020-12-17)

5.0.0-pre.0 (2020-05-19)

Note: Version bump only for package @feathersjs/authentication-oauth

5.0.0-pre.0 (2020-05-19)

Note: Version bump only for package @feathersjs/authentication-oauth

4.5.9 (2020-10-09)

Bug Fixes

  • authentication-oauth: Always end session after oAuth flows are finished (#2087) (d219d0d)

4.5.8 (2020-08-12)

Note: Version bump only for package @feathersjs/authentication-oauth

4.5.7 (2020-07-24)

Bug Fixes

  • typescript: Revert add overload types for find service methods (#1972)" (#2025) (a9501ac)

4.5.6 (2020-07-12)

Note: Version bump only for package @feathersjs/authentication-oauth

4.5.5 (2020-07-11)

Bug Fixes

  • authentication-oauth: Updated typings for projects with strictNullChecks (#1941) (be91206)
  • typescript: add overload types for find service methods (#1972) (ef55af0)

4.5.4 (2020-04-29)

Bug Fixes

  • authentication-oauth: Add getEntity method to oAuth authentication and remove provider field for other calls (#1935) (d925c1b)

4.5.3 (2020-04-17)

Bug Fixes

  • authentication-oauth: Allow req.feathers to be used in oAuth authentication requests (#1886) (854c9ca)

4.5.2 (2020-03-04)

Bug Fixes

  • package: update grant-profile to version 0.0.11 (#1841) (5dcd2aa)

4.5.1 (2020-01-24)

Note: Version bump only for package @feathersjs/authentication-oauth

4.5.0 (2020-01-18)

Features

  • authentication-oauth: Set oAuth redirect URL dynamically and pass query the service (#1737) (0b05f0b)

4.4.3 (2019-12-06)

Note: Version bump only for package @feathersjs/authentication-oauth

4.4.1 (2019-11-27)

Note: Version bump only for package @feathersjs/authentication-oauth

4.4.0 (2019-11-27)

Features

  • authentication-oauth: Set oAuth redirect URL dynamically (#1608) (1293e08)

4.3.11 (2019-11-11)

Bug Fixes

  • authentication-oauth: Allow hash based redirects (#1676) (ffe7cf3)

4.3.10 (2019-10-26)

Note: Version bump only for package @feathersjs/authentication-oauth

4.3.9 (2019-10-26)

Bug Fixes

  • Only initialize default Express session if oAuth is actually used (#1648) (9b9b43f)

4.3.7 (2019-10-14)

Note: Version bump only for package @feathersjs/authentication-oauth

4.3.5 (2019-10-07)

Note: Version bump only for package @feathersjs/authentication-oauth

4.3.4 (2019-10-03)

Note: Version bump only for package @feathersjs/authentication-oauth

4.3.3 (2019-09-21)

Bug Fixes

  • Small improvements in dependencies and code sturcture (#1562) (42c13e2)

4.3.2 (2019-09-16)

Note: Version bump only for package @feathersjs/authentication-oauth

4.3.1 (2019-09-09)

Bug Fixes

  • Omit standard protocol ports from the default hostname (#1543) (ef16d29)

4.3.0 (2019-08-27)

Note: Version bump only for package @feathersjs/authentication-oauth

4.3.0-pre.4 (2019-08-22)

Note: Version bump only for package @feathersjs/authentication-oauth

4.3.0-pre.3 (2019-08-19)

Bug Fixes

  • Update all dependencies (7d53a00)
  • Use WeakMap to connect socket to connection (#1509) (64807e3)

4.3.0-pre.2 (2019-08-02)

Bug Fixes

  • Add method to reliably get default authentication service (#1470) (e542cb3)

4.3.0-pre.1 (2019-07-11)

Note: Version bump only for package @feathersjs/authentication-oauth

4.0.0-pre.5 (2019-07-10)

Note: Version bump only for package @feathersjs/authentication-oauth

4.0.0-pre.4 (2019-07-05)

Note: Version bump only for package @feathersjs/authentication-oauth

4.0.0-pre.3 (2019-06-01)

Bug Fixes

  • Make oAuth paths more consistent and improve authentication client (#1377) (adb2543)
  • Update dependencies and fix tests (#1373) (d743a7f)

4.0.0-pre.2 (2019-05-15)

Bug Fixes

  • Correctly read the oauth strategy config (#1349) (9abf314)

Features

4.0.0-pre.1 (2019-05-08)

Bug Fixes

  • Always require strategy parameter in authentication (#1327) (d4a8021)
  • Improve authentication parameter handling (#1333) (6e77204)
  • Improve oAuth option handling and usability (#1335) (adb137d)
  • Merge httpStrategies and authStrategies option (#1308) (afa4d55)
  • Rename jwtStrategies option to authStrategies (#1305) (4aee151)

Features

4.0.0-pre.0 (2019-04-21)

Features