Node.js SDK

Installation

JavaScript

 npm install @workos-inc/node

 yarn add @workos-inc/node

Releases

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

v6.8.0

March 29, 2024

What's Changed

Add screen hint to getAuthorizationUr

v6.7.0

March 21, 2024

Added

Add session.created event (https://github.com/workos/workos-node/pull/993)

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.

v6.5.0

March 20, 2024

Changed

accessToken and refreshToken on AuthenticationResponse are no longer marked optional.

6.4.0

March 19, 2024

Added

Added impersonation fields to authentication response along with related user.impersonated event (#987)

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)

v6.2.0

March 14, 2024

Added

Add ssha as valid passwordHashType (#983)

Add userManagement.getJwksUrl (#980)

v6.1.0

March 6, 2024

Added

Endpoints for dealing with sessions and tokens (#974)

v6.0.3

February 28, 2024

Fixed

Expose non-publicly documented properties in auth response (#971)

Full Changelog: https://github.com/workos/workos-node/compare/v6.0.2...v6.0.3

v6.0.2

February 20, 2024

Fixed

Fixed issues with APIs that don't return a response body (#969)

Full Changelog: v6.0.1...v6.0.2

v6.0.1

February 19, 2024

Fixed

Fixed Cloudflare worker incompatibility (#965)

Fixed workos.userManagement.revokeInvitation API call (#966)

Full Changelog: v6.0.0...v6.0.1

v6.0.0

February 13, 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 support for Cloudflare Workers, Deno and other Edge runtime environments. (#962)

Changed

Removed axios and used native fetch instead

[Breaking change] The WorkOS constructor's options (WorkOSOptions) used to take axios: AxiosRequestConfig. This has now be replaced by config: RequestInit

Webhooks APIs now use web crypto instead of node's built-in crypto module

[Breaking change] This means the webhooks APIs such as constructEvent are now async

[Breaking change] This also means that the minimum Node version required for v6.0.0 is Node V19 in order to support web crypto if you are using the Webhooks APIs

Full Changelog: https://github.com/workos/workos-node/compare/v5.2.0...v6.0.0

v5.2.0

February 7, 2024

Added

Add profile_picture_url attribute to the user object by @hadihallak in https://github.com/workos/workos-node/pull/958

Full Changelog: https://github.com/workos/workos-node/compare/v5.1.4...v5.2.0

v5.1.4

January 25, 2024

Fixed

Added final fixes for serializing options on auto paginated list objects (#955)

v5.1.3

January 25, 2024

Fix options for list /connections auto-pagination (https://github.com/workos/workos-node/pull/952)

v4.0.3

January 25, 2024

Fixed

Added fix for serializing options on auto paginated list objects (#953)

v3.9.3

January 25, 2024

Fixed

Added fix for serializing options on auto paginated list objects (#956)

v5.1.2

January 24, 2024

Fixed

Fix options for auto-pagination (#949)

v4.0.2

January 17, 2024

What's Changed

Upgrade axios to v1.6.5 (https://github.com/workos/workos-node/pull/946)

(Fixes 4.0.1 release)

v5.1.1

January 11, 2024

What's Changed

Bump up maximum pagination limit from 10 to 100 (#942)

v4.0.1

January 12, 2024

What's Changed

Upgraded axios to v1.6.5

v4.0.0 by @amygdalama in https://github.com/workos/workos-node/pull/925

Full Changelog: https://github.com/workos/workos-node/compare/v4.0.0...v4.0.1

v5.0.1

January 10, 2024

What's Changed

Upgraded axios to v1.6.5 (#937)

Full Changelog: https://github.com/workos/workos-node/compare/v5.0.0...v5.0.1

v3.9.2

January 10, 2024

What's Changed

Upgraded axios to v1.6.5 (#940)

Full Changelog: https://github.com/workos/workos-node/compare/v3.9.1...v3.9.2

v5.0.0

January 5, 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

Add firebase-scrypt as valid passwordHashType (https://github.com/workos/workos-node/pull/933)

Changed

[Breaking Change] Mark organizationId as optional in authentication responses (https://github.com/workos/workos-node/pull/932)

Removed

Removed deprecated directory provider types (https://github.com/workos/workos-node/pull/930)

Removed "suspended" state on Directory Sync User object (https://github.com/workos/workos-node/pull/931)

Upgrading from Beta User Management API

If you're upgrading from a beta version of the User Management API, contact us at support@workos.com for a full changelog and assistance upgrading.

Full Changelog: https://github.com/workos/workos-node/compare/v4.0.0...v5.0.0

v4.0.0

November 27, 2023

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

Added

Stable release of User Management API: https://workos.com/docs/user-management

Changed

[Breaking change] Fix directory user interface to reflect nullable attributes (#881)

[Breaking change] Standardize casing of Client ID to clientId (https://github.com/workos/workos-node/pull/897)

[Breaking change] Standardize casing of redirectURI to redirectUri https://github.com/workos/workos-node/pull/926

[Breaking change] Fix MFA Challenge and ChallengeResponse interfaces to reflect optional code property (https://github.com/workos/workos-node/pull/911)

[Breaking change] Fix MFA response types to more accurately reflect API responses. (https://github.com/workos/workos-node/pull/917), (https://github.com/workos/workos-node/pull/927), (https://github.com/workos/workos-node/pull/929)

Removed

[Breaking change] Remove deprecated Audit Trail package (https://github.com/workos/workos-node/pull/916)

Upgrading from Beta User Management API

If you're upgrading from a beta version of the User Management API, contact us at support@workos.com for a full changelog and assistance upgrading.

Full Changelog: https://github.com/workos/workos-node/compare/v3.9.0...v4.0.0

v3.9.1

November 15, 2023

What's Changed

Upgraded axios to v1.6.0 (#889)

v3.9.0

November 13, 2023

Changed

Updated developer domain verification strategy to manual https://github.com/workos/workos-node/pull/879

v3.8.0

November 7, 2023

Add domain verification

Add serializer for events

v3.7.1

October 19, 2023

What's Changed

Add rate limiting to auto pagination (4 RPS)