WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Node.js SDK

github.com
workos/workos-node
140 Stars
35 Forks
63 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

April 21, 2025

v7.47.0

Latest
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

January 10, 2025

v7.36.1

January 10, 2025

What's Changed

  • set JWKS cache duration to 5 minutes by @nicknisi in https://github.com/workos/workos-node/pull/1196

New Contributors

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

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

January 2, 2025

v7.36.0

January 2, 2025

What's Changed

  • Update constructAction default tolerance to 30000ms (#1191)
  • Add GET /organization/:orgId/roles API support (#1188)

Full Changelog: https://github.com/workos/workos-node/compare/v7.35.1...v7.36.0

December 12, 2024

v7.35.1

December 12, 2024

What's Changed

  • Use a non-default ttl with iron-session by @PaulAsjes in https://github.com/workos/workos-node/pull/1186

Full Changelog: https://github.com/workos/workos-node/compare/v7.35.0...v7.35.1

December 4, 2024

v7.35.0

December 4, 2024

What's Changed

  • Return action type by @tribble in https://github.com/workos/workos-node/pull/1179
  • Add accept-invite function by @dandorman in https://github.com/workos/workos-node/pull/1180

Full Changelog: https://github.com/workos/workos-node/compare/v7.34.0...v7.35.0

November 26, 2024

v7.34.0

November 26, 2024

What's Changed

  • fix: Update session.refresh to correctly maintain previous orgId by @cmanou in https://github.com/workos/workos-node/pull/1176
  • Add access token to authentication response by @PaulAsjes in https://github.com/workos/workos-node/pull/1163

Full Changelog: https://github.com/workos/workos-node/compare/v7.33.1...v7.34.0

November 22, 2024

v7.33.1

November 22, 2024

Changed

  • Make metadata optional when creating audit log schema (#1175)

Full Changelog: https://github.com/workos/workos-node/compare/v7.33.0...v7.33.1

November 19, 2024

v7.33.0

November 19, 2024

What's Changed

  • Add Actions https://github.com/workos/workos-node/pull/1172

Full Changelog: https://github.com/workos/workos-node/compare/v7.32.0...v7.33.0

November 15, 2024

v7.32.0

November 15, 2024

Added

  • Add Passkey to AuthenticationMethod union (#1166)

Full Changelog: https://github.com/workos/workos-node/compare/v7.31.0...v7.32.0

November 14, 2024

v7.31.0

November 14, 2024

What's Changed

  • Add NodeHttpClient and FetchHttpClient tests for retry logic by @stanleyphu in https://github.com/workos/workos-node/pull/1154
  • Remove org Stripe customer ID setter/getter by @dandorman in https://github.com/workos/workos-node/pull/1160
  • Add oauthTokens to AuthenticationResponse by @jonatascastro12 in https://github.com/workos/workos-node/pull/1164
  • Bump version to v7.31.0 by @jonatascastro12 in https://github.com/workos/workos-node/pull/1165

Full Changelog: https://github.com/workos/workos-node/compare/v7.30.1...v7.31.0

November 12, 2024

v7.31.0-beta.actions1

Pre-release
November 12, 2024

What's Changed

  • Add actions support by @faroceann in https://github.com/workos/workos-node/pull/1161

Full Changelog: https://github.com/workos/workos-node/compare/v7.9.0...v7.31.0-beta.actions1

November 6, 2024

v7.30.1

November 6, 2024

What's Changed

  • Throws non-retryable errors in NodeHttpClient https://github.com/workos/workos-node/pull/1155

Full Changelog: https://github.com/workos/workos-node/compare/v7.30.0...v7.30.1

October 25, 2024

v7.30.0

October 25, 2024

What's Changed

  • Added network retries to FGA module https://github.com/workos/workos-node/pull/1134

Full Changelog: https://github.com/workos/workos-node/compare/v7.29.1...v7.30.0

October 24, 2024

v7.29.1

October 24, 2024

Changed

  • Fixed incorrect organization domain interface (https://github.com/workos/workos-node/pull/1145)
    • Updated verificationToken on OrganizationDomain to optional (it was always optional from the API's perspective)
    • Updated Organization deserialization to correctly deserialize verificationToken and verificationStrategy for the organization's domains