Installation

Usage

The AuthKit React SDK provides React hooks and components for integrating AuthKit authentication into React applications.

Refer to the AuthKit documentation for detailed usage instructions and examples.

Beta Versions

Certain WorkOS features may be available only in the beta version of the SDK. Beta versions have the -beta.* suffix, for example, 3.2.0-beta.1. For more information on how to use the beta versions, refer to the README in the GitHub repository.

Releases

January 15, 2026

v0.16.0

Latest
January 15, 2026

What's Changed

  • Upgrade authkit-js to v0.19.0 by @nholden in #85

Full Changelog: v0.15.1...v0.16.0

January 13, 2026

v0.15.1

January 13, 2026

What's Changed

  • feat: enable npm Trusted Publishers by @nicknisi in #79
  • Add authenticationMethod to state by @ohjonah in #80
  • v0.15.0 by @nholden in #81

New Contributors

  • @ohjonah made their first contribution in #80
  • @nholden made their first contribution in #81

Full Changelog: v0.15.0...v0.15.1

December 24, 2025

v0.15.0

December 24, 2025

What's Changed

  • feat: enable npm Trusted Publishers by @nicknisi in #79
  • Add authenticationMethod to state by @ohjonah in #80
  • v0.15.0 by @nholden in #81

New Contributors

  • @ohjonah made their first contribution in #80
  • @nholden made their first contribution in #81

Full Changelog: v0.14.0...v0.15.0

December 12, 2025

v0.14.0

December 12, 2025

What's Changed

  • Add npm logs and system file to .gitignore by @chaance in #73
  • feat: expose getSignInUrl and getSignUpUrl from authkit-js via useClient by @K-Mistele in #75
  • re-export errors and types from authkit-js by @zac-workos in #76
  • version bump to 0.14.0 by @zac-workos in #77

New Contributors

  • @K-Mistele made their first contribution in #75
  • @zac-workos made their first contribution in #76

Full Changelog: v0.13.0...v0.14.0

September 18, 2025

v0.13.0

September 18, 2025

What's Changed

  • Add roles from JWT payload by @atainter in #71
  • v0.13.0 by @atainter in #72

New Contributors

  • @atainter made their first contribution in #71

Full Changelog: v0.12.0...v0.13.0

September 3, 2025

v0.12.0

September 3, 2025

What's Changed

  • docs: Add destructuring to onRedirectCallback example to access state by @heatherfaerber in #67
  • Add impersonator support by @nicknisi in #69

New Contributors

  • @heatherfaerber made their first contribution in #67

Full Changelog: v0.11.0...v0.12.0

June 19, 2025

v0.11.0

June 19, 2025

What's Changed

  • Add support for feature_flags claim by @kkajla12 in #65

Full Changelog: v0.10.0...v0.11.0

May 21, 2025

v0.10.0

May 21, 2025

What's Changed

  • Add section about passing data through authentication flows to README by @nicknisi in #56
  • upgrade authkit-js to v0.11.0 by @nicknisi in #61
  • v0.10.0 by @nicknisi in #62

This release adds the following functionality from authkit-js

  • Remove 'impersonation coming soon' error message by @nholden in #80
  • Deprecate context option on getAuthorizationUrl and signIn by @nholden in #83
  • Add forceRefresh option to getAccessToken method by @nicknisi in #85
  • Improve compatibility with hybrid mobile apps by @vdsbenoit in #84

Full Changelog: v0.9.1...v0.10.0

April 8, 2025

v0.9.1

April 8, 2025

What's Changed

  • remove caveat about impersonation by @cmatheson in #48
  • Add coana workflows by @nicknisi in #49
  • Add coana-guardrail and coana-analysis workflows by @nicknisi in #50
  • Add coana-guardrail and coana-analysis workflows by @nicknisi in #51
  • Update authkit-js to v0.10.1 by @nicknisi in #54
  • v0.9.1 by @nicknisi in #55

New Contributors

  • @nicknisi made their first contribution in #49

Full Changelog: v0.9.0...v0.9.1

January 15, 2025

v0.9.0

January 15, 2025

Added

  • Bumped dependency on @workos-inc/authkit-js to 0.9.0, exposing new returnTo parameter for signOut helper (#46)

Full Changelog: v0.8.1...v0.9.0

January 9, 2025

v0.8.1

January 9, 2025

Changes

January 1, 2025

v0.8.0

January 1, 2025

Changes

December 13, 2024

v0.7.2

December 13, 2024

Added

  • onRefreshFailed and onRefresh callbacks are available on AuthKitProvider (#35)

Changed

  • upgraded to authkit-js v0.7.2
December 3, 2024

v0.7.1

December 3, 2024

Updates authkit-js to 0.7.1

November 12, 2024

v0.7.0

November 12, 2024

Added

  • switchToOrganization (#31)
November 1, 2024

v0.6.0

November 1, 2024

Added

  • Updated @workos-inc/authkit-js to the latest version which contains under-the-hood improvements for more robust session refreshing. (#29)
September 16, 2024

v0.5.1

September 16, 2024
  • Fixed an issue with updating the role in useAuth()
  • Updated @workos-inc/authkit-js to v0.5.1
  • Added information about configuring a login initiation endpoint to the README.
September 9, 2024

v0.5.0

September 9, 2024

Upgrades authkit-js to 0.5.0 (Adds the context parameter to signIn/signUp)

August 30, 2024

v0.4.1

August 30, 2024

Bumps @workos-inc/authkit-js to 0.4.1

August 30, 2024

v0.4.0

August 30, 2024
  • Updates @workos-inc/authkit-js v0.4.0 (Release notes)
  • Adds getClaims function from authkit-js to decode access tokens
August 14, 2024

v0.3.2

August 14, 2024

Bumps @workos-inc/authkit-js to v0.2.2 (which fixes a refresh bug).

August 12, 2024

v0.3.1

August 12, 2024

Fixes

  • Update state in AuthKitProvider only when data meaningfully changes (previously this was happening on every refresh)
  • Bump authkit-js to 0.2.1
August 8, 2024

v0.3.0

August 8, 2024

Changes

Bumps @workos-inc/authkit-js to v0.2.0.

August 7, 2024

v0.2.0

August 7, 2024

Adds:

  • useAuth() also returns organizationId, role, and permissions.

Changes:

  • user (from useAuth()) is now updated as new refresh tokens are received
  • upgrades to @workos-inc/authkit-js v0.1.0
August 1, 2024

v0.1.2

August 1, 2024

Changed

  • relax React peer dependency requirements
  • improve compatibility with older bundlers
July 24, 2024

v0.1.1

July 24, 2024

Changed

  • More information in README.md
July 24, 2024

v0.1.0

July 24, 2024