WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Node.js SDK

github.com
workos/workos-node
151 Stars
38 Forks
65 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

June 27, 2025

v7.57.0

Latest
June 27, 2025

What's Changed

  • Add authenticateWithCodeAndVerifier method for strict PKCE enforcement by @nicknisi in https://github.com/workos/workos-node/pull/1297

Full Changelog: https://github.com/workos/workos-node/compare/v7.56.0...v7.57.0

June 26, 2025

v7.56.0

June 26, 2025

What's Changed

  • Add session.revoked event: https://github.com/workos/workos-node/pull/1294

Full Changelog: https://github.com/workos/workos-node/compare/v7.55.0...v7.56.0

June 20, 2025

v7.55.0

June 20, 2025

What's Changed

  • Add feature flags to parsed access-token results by @kkajla12 in https://github.com/workos/workos-node/pull/1295

Full Changelog: https://github.com/workos/workos-node/compare/v7.54.0...v7.55.0

June 12, 2025

v8.0.0-beta.2

Pre-release
June 12, 2025

Full Changelog: https://github.com/workos/workos-node/compare/v8.0.0-beta.1...v8.0.0-beta.2

June 11, 2025

v8.0.0-beta.1

Pre-release
June 11, 2025

Full Changelog: https://github.com/workos/workos-node/compare/v7.54.0...v8.0.0-beta.1

June 5, 2025

v7.54.0

June 5, 2025

What's Changed

  • Export Identity/IdentityResponse interfaces (#1291)

Full Changelog: https://github.com/workos/workos-node/compare/v7.53.0...v7.54.0

May 30, 2025

v7.53.0

May 30, 2025

What's Changed

  • Renamed and deprecated the AuthorizationURLOptions interfaces (https://github.com/workos/workos-node/pull/1282)
  • Added support for provider_scopes query param (https://github.com/workos/workos-node/pull/1288)

Full Changelog: https://github.com/workos/workos-node/compare/v7.52.0...v7.53.0

May 26, 2025

v7.52.0

May 26, 2025

What's Changed

  • adds organization_name to ListOrganizationMemberships response #1285
May 22, 2025

v7.51.0

May 22, 2025

What's Changed

  • adds email to UpdateUserOptions #1273
  • deserializes FGA warnings #1280
May 16, 2025

v7.50.1

May 16, 2025

What's Changed

  • Remove duplicate crypto files by @nicknisi in https://github.com/workos/workos-node/pull/1268
  • Fix Vault crypto implementation for edge runtime compatibility by @nicknisi in https://github.com/workos/workos-node/pull/1269
  • Allow null value metadata by @kaylagordon in https://github.com/workos/workos-node/pull/1274
  • v7.50.1 by @nicknisi in https://github.com/workos/workos-node/pull/1275

New Contributors

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

Full Changelog: https://github.com/workos/workos-node/compare/v7.50.0...v7.50.1

May 5, 2025

v7.50.0

May 5, 2025

What's Changed

  • Support optional authenticated data in local encrypt/decrypt by @hexedpackets in https://github.com/workos/workos-node/pull/1264

Full Changelog: https://github.com/workos/workos-node/compare/v7.49.0...v7.50.0

May 2, 2025

v7.49.0

May 2, 2025

What's Changed

  • Deprecate context option on getAuthorizationUrl by @nholden in https://github.com/workos/workos-node/pull/1263
  • feat: add authentication.radar_risk_detected event by @faroceann in https://github.com/workos/workos-node/pull/1265

Full Changelog: https://github.com/workos/workos-node/compare/v7.48.0...v7.49.0

April 25, 2025

v7.48.0

April 25, 2025

What's Changed

  • Add customAttributes field to SSO Profile (#1261)

Full Changelog: https://github.com/workos/workos-node/compare/v7.47.0...v7.48.0

April 21, 2025

v7.47.0

April 21, 2025

Full Changelog: https://github.com/workos/workos-node/compare/v7.46.0...v7.47.0

Full Changelog: https://github.com/workos/workos-node/compare/v7.46.0...v7.47.0

What's Changed

  • Add organizationId to organization domain by @ajworkos in https://github.com/workos/workos-node/pull/1259
  • version 7.47.0 by @ajworkos in https://github.com/workos/workos-node/pull/1260

New Contributors

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

Full Changelog: https://github.com/workos/workos-node/compare/v7.46.0...v7.47.0

April 9, 2025

v7.46.0

April 9, 2025

What's Changed

  • Added password_reset.succeeded event type (https://github.com/workos/workos-node/pull/1256)

Full Changelog: https://github.com/workos/workos-node/compare/v7.45.0...v7.46.0

March 27, 2025

v7.45.0

March 27, 2025

What's Changed

  • Rename Vault secrets to objects by @hexedpackets in https://github.com/workos/workos-node/pull/1247

Full Changelog: https://github.com/workos/workos-node/compare/v7.44.0...v7.45.0

March 21, 2025

v7.44.0

March 21, 2025

What's Changed

  • Add email standard attribute to DirectoryUser (#1223)
  • Mark emails, job_title, and username standard attributes as deprecated. Enable the equivalent auto-mapped custom attributes instead (#1223)

Full Changelog: https://github.com/workos/workos-node/compare/7.43.1...v7.44.0

March 21, 2025

7.43.1

March 21, 2025

What's Changed

  • Make the scopes field optional by @lucasmotta in https://github.com/workos/workos-node/pull/1243

New Contributors

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

Full Changelog: https://github.com/workos/workos-node/compare/v7.43.0...7.43.1

March 19, 2025

v7.43.0

March 19, 2025

What's Changed

  • Add metadata to organizations and users from https://github.com/workos/workos-node/pull/1241

Full Changelog: https://github.com/workos/workos-node/compare/v7.42.0...v7.43.0

March 19, 2025

v7.42.0

March 19, 2025
  • Added support for WorkOS Vault from #1236. See Vault quick start docs here
March 10, 2025

v7.41.0

March 10, 2025

What's Changed

  • Add external id support for organizations from https://github.com/workos/workos-node/pull/1232

Full Changelog: https://github.com/workos/workos-node/compare/v7.40.1...v7.41.0

March 7, 2025

v7.40.1

March 7, 2025

What's Changed

Fixed

  • Changed sessions to reuse JWKS (#1233)

Full Changelog: https://github.com/workos/workos-node/compare/v7.40.0...v7.40.1

March 6, 2025

v7.40.0

March 6, 2025

What's Changed

  • Add externalId support to users in https://github.com/workos/workos-node/pull/1228
  • Add getUserByExternalId in https://github.com/workos/workos-node/pull/1229

Full Changelog: https://github.com/workos/workos-node/compare/v7.39.0...v7.40.0

February 19, 2025

v7.39.0

February 19, 2025

What's Changed

  • Added lastSignInAt to user (https://github.com/workos/workos-node/pull/1220)

Full Changelog: https://github.com/workos/workos-node/compare/v7.38.0...v7.39.0

February 7, 2025

v7.38.0

February 7, 2025

What's Changed

  • Add permissions to roles events and organization roles API (#1216)
  • Update Session#refresh() to return all session JWT claims (#1218)
  • Expose the warrant_token attribute returned by the FGA check endpoint to the caller (#1212)

Full Changelog: https://github.com/workos/workos-node/compare/v7.37.2...v7.38.0

January 28, 2025

v7.37.2

January 28, 2025

What's Changed

  • Update Coana Guardrail to not require API key for run by @marji-workos in #1214
  • Export role types by @kevinmitch14 in #1207

New Contributors

  • @kevinmitch14 made their first contribution in #1207

Full Changelog: https://github.com/workos/workos-node/compare/v7.37.1...v7.37.2

January 21, 2025

v7.37.1

January 21, 2025

What's Changed

  • Update coana-guardrail.yml by @marji-workos in https://github.com/workos/workos-node/pull/1208
  • Fix library compatibility with workers environment by @nicknisi in https://github.com/workos/workos-node/pull/1210
  • Bump to v7.37.1 by @nicknisi in https://github.com/workos/workos-node/pull/1211

Full Changelog: https://github.com/workos/workos-node/compare/v7.37.0...v7.37.1

January 14, 2025

v7.37.0

January 14, 2025

Added

  • Added returnTo option to getLogoutUrl methods (#1200)

Full Changelog: https://github.com/workos/workos-node/compare/v7.36.3...v7.37.0

January 13, 2025

v7.36.3

January 13, 2025

What's Changed

  • version bump to 7.36.3 by @debussyman in https://github.com/workos/workos-node/pull/1199

Full Changelog: https://github.com/workos/workos-node/compare/v7.36.2...v7.36.3

January 13, 2025

v7.36.2

January 13, 2025

What's Changed

  • add deviceFingerprint attributes to Action payload interface by @debussyman in https://github.com/workos/workos-node/pull/1199

New Contributors

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

Full Changelog: https://github.com/workos/workos-node/compare/v7.36.1...v7.36.2