WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Node.js SDK

github.com
workos/workos-node
107 Stars
25 Forks
51 Contributors
github.com
Official Node.js SDK for interacting with the WorkOS API.

Installation

JavaScript

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

July 26, 2024

v7.17.1

Latest
July 26, 2024

What's Changed

  • Fix invalid session cookie enum name (#1088)

Full Changelog: https://github.com/workos/workos-node/compare/v7.17.0...v7.17.1

July 24, 2024

v7.17.0

July 24, 2024

Added

  • Added support for FGA endpoints https://github.com/workos/workos-node/pull/1077
July 23, 2024

v7.16.0

July 23, 2024

Added

  • Added support for authentication events (#998)
July 23, 2024

v7.15.0

July 23, 2024

Added

  • Simplify AuthKit session handling with new authenticateWithSessionCookie and refreshAndSealSessionData methods, and the ability to optionally seal session data on all authenticateWith* methods (#1078)

Full Changelog: https://github.com/workos/workos-node/compare/v7.14.0...v7.15.0

July 18, 2024

v7.14.0

July 18, 2024

What's Changed

  • Add Apple OAuth support by @gcarvelli in https://github.com/workos/workos-node/pull/1059

Full Changelog: https://github.com/workos/workos-node/compare/v7.13.0...v7.14.0

July 10, 2024

v7.13.0

July 10, 2024

What's Changed

  • Adds getUserIdentities method by @PaulAsjes in https://github.com/workos/workos-node/pull/1075
  • Bump to v7.13.0 by @PaulAsjes in https://github.com/workos/workos-node/pull/1076

Full Changelog: https://github.com/workos/workos-node/compare/v7.12.0...v7.13.0

July 8, 2024

v7.12.0

July 8, 2024

What's Changed

  • Updated the return type of workos.userManagement.authenticateWithRefreshToken to match other authenticateWith methods.
July 2, 2024

v7.11.4

July 2, 2024

Fixed

  • Fix NodeHttpClient handling of URLSearchParam request bodies by @mthadley in https://github.com/workos/workos-node/pull/1071
June 24, 2024

v7.11.3

June 24, 2024

What's Changed

  • fix(package): add default exports for non-ESM projects by @Leestex in https://github.com/workos/workos-node/pull/1068
  • Bump version to 7.11.3 by @PaulAsjes in https://github.com/workos/workos-node/pull/1069

New Contributors

  • @Leestex made their first contribution in https://github.com/workos/workos-node/pull/1068

Full Changelog: https://github.com/workos/workos-node/compare/v7.11.2...v7.11.3

June 21, 2024

v7.11.2

June 21, 2024

What's Changed

  • Fix typings and release by @PaulAsjes in https://github.com/workos/workos-node/pull/1067

Full Changelog: https://github.com/workos/workos-node/compare/v7.11.1...v7.11.2

June 21, 2024

v7.11.1

June 21, 2024

What's Changed

  • Fix typings path by @PaulAsjes in https://github.com/workos/workos-node/pull/1065
  • v7.11.1 by @PaulAsjes in https://github.com/workos/workos-node/pull/1066

Full Changelog: https://github.com/workos/workos-node/compare/v7.11.0...v7.11.1

June 20, 2024

v7.11.0

June 20, 2024

Fixed

  • Fixed compatibility with Cloudflare Worker environment (#1062)
  • Fixed parameter serialization for the List Auth Factors method in User Management (#1063)

Deprecated

  • Mark the allowProfilesOutsideOrganization option for Organizations as deprecated (#1060)
June 10, 2024

v7.10.0

June 10, 2024

What's Changed

  • End node-compatibility beta by @PaulAsjes in https://github.com/workos/workos-node/pull/1057
  • Bump to v7.10.0 by @PaulAsjes in https://github.com/workos/workos-node/pull/1058

Full Changelog: https://github.com/workos/workos-node/compare/v7.9.0...v7.10.0

June 5, 2024

v7.9.0

June 5, 2024
  • Adds support for PKCE params on User management authentication methods
June 4, 2024

v7.8.0

June 4, 2024

Added

  • Added a method to find an invitation using the token (#1053)
June 3, 2024

v7.7.0

June 3, 2024

Added

  • Added support for totpSecret on userManagement.enrollAuthFactor (#1051)
May 24, 2024

v7.6.0

May 24, 2024

Added

  • Added support for email_verification.created and password_reset.created events (#1048)
  • Added new endpoints to the User Management API to support sending your own emails: getEmailVerification, getPasswordReset, and createPasswordReset (#1048)
  • Deprecation notice for the sendPasswordResetEmail method in favor of createPasswordReset (#1048)
  • Added role to directory user (#1046)

Updated

  • Updated dependency ts-jest to v29.1.3 (#1044)
May 22, 2024

v7.5.0-beta.node-compatibility

Pre-release
May 22, 2024

Full Changelog: https://github.com/workos/workos-node/compare/v7.5.0-beta.node-backwards-compatibility...v7.5.0-beta.node-compatibility

What's Changed

  • Adds backwards compatibility for older versions of Node

Full Changelog: https://github.com/workos/workos-node/compare/v7.5.0...v7.5.0-beta.node-compatibility

May 20, 2024

v7.5.0

May 20, 2024

Added

  • Add organization membership deactivate and reactivate API methods (#1042)
May 9, 2024

v7.4.0

May 9, 2024

Added

  • Added inviterUserId to invitation object returned by API (#1040)
May 3, 2024

v7.3.0

May 3, 2024

Added

  • Added acceptInvitationUrl to invitation object returned by API (#1036)
  • Added new event types: invitation.created and magic_auth.created (#1036)
  • Added new endpoints for the Magic Auth API: getMagicAuth and createMagicAuth (#1036)
  • Deprecation notice for sendMagicAuthCode method in favor of createMagicAuth (#1036)
April 30, 2024

v7.2.0

April 30, 2024

Added

  • Support organizationId as an optional parameter for the Events API (https://github.com/workos/workos-node/pull/1034)
  • Include authenticationMethod in the authentication response (https://github.com/workos/workos-node/pull/1031)
  • New Event types organization_membership.created and organization_membership.deleted (https://github.com/workos/workos-node/pull/1028)
  • Using domain_data in Organization API options (https://github.com/workos/workos-node/pull/1025)
April 22, 2024

v7.1.0

April 22, 2024

Added

  • Added organization.created event (https://github.com/workos/workos-node/pull/1024)
  • Added organization.updated event (https://github.com/workos/workos-node/pull/1024)
  • Added organization.deleted event (https://github.com/workos/workos-node/pull/1024)
April 9, 2024

v7.0.0

April 9, 2024

This is a major release of the WorkOS API that may contain breaking changes for your application. Please carefully read these release notes and contact support@workos.com if you encounter any issues.

Added

  • Added appInfo configuration object for metrics
  • Added optional role_slug parameter to user management send invitation payload to specify a user's organization membership role when inviting
  • Added 'password_hash' and 'password_hash_type' to User creation

Changed

  • workos-node now requires a minimum Node version of 19
  • Events array is now required for listEvents

Removed

  • Removed domain parameters from directories list query

Full Changelog: https://github.com/workos/workos-node/compare/v6.8.0...v7.0.0

March 29, 2024

v6.8.0

March 29, 2024

What's Changed

  • Add screen hint to getAuthorizationUr
March 21, 2024

v6.7.0

March 21, 2024

Added

  • Add session.created event (https://github.com/workos/workos-node/pull/993)
March 20, 2024

v6.6.0

March 20, 2024

Removed

  • Remove separate user.impersonated event (https://github.com/workos/workos-node/pull/990)
    • This event was never emitted by the API and has been superseded by session.created.
March 20, 2024

v6.5.0

March 20, 2024

Changed

  • accessToken and refreshToken on AuthenticationResponse are no longer marked optional.
March 19, 2024

6.4.0

March 19, 2024

Added

  • Added impersonation fields to authentication response along with related user.impersonated event (#987)
March 18, 2024

6.3.0

March 18, 2024

Added

  • Role parameter to User Management OrganizationMembership API, and new PUT endpoint for User Management OrganizationMembership API (https://github.com/workos/workos-node/pull/979)