Node.js SDK

Installation

 npm install @workos-inc/node

Releases

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 already using 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)

v3.7.0

September 14, 2023

Added

Add authenticateWithTotp method https://github.com/workos/workos-node/pull/856

Add listAuthFactors method https://github.com/workos/workos-node/pull/857

All authentication methods should pass ipAddress and userAgent https://github.com/workos/workos-node/pull/861

Changed

Change magicAuthChallengedId to userId on authenticateUserWithMagicAuth https://github.com/workos/workos-node/pull/850

Update verifyEmailCode method to handle nested user object in return https://github.com/workos/workos-node/pull/853

Rename completePasswordReset to resetPassword and change response https://github.com/workos/workos-node/pull/854

Rename createPasswordResetChallenge to sendPasswordResetEmail https://github.com/workos/workos-node/pull/855

Rename enrollUserInMfaFactor to enrollAuthFactor https://github.com/workos/workos-node/pull/858

Update sendMagicAuthCode to take email rather than email_address https://github.com/workos/workos-node/pull/860

Fix listAuthFactors() return https://github.com/workos/workos-node/pull/862

Removed

Remove MagicAuthChallenge interface https://github.com/workos/workos-node/pull/851

v3.5.0

August 25, 2023

Changed

Migrated verifyEmail to verifyEmailCode (#841)

Migrated createEmailVerification to sendVerificationEmail (#842)

Fixed

Fixed the shape of the response in sendMagicAuthCode (#843)

Fixed the shape of the response in sendVerificationEmail (#844)

v3.4.0

August 25, 2023

Added

Added deleteUser (#836)

Changed

Renamed emailVerifiedAt to emailVerified in user object (#834)

Updated updateUser to use email_verified rather than email_verified_at (#839)

Migrated completeEmailVerification to verifyEmail (#842)

Removed

Removed Session endpoints (#835)

Removed distinction between managed and unmanaged users (#831)

v3.3.0

August 18, 2023

Added

Added the emailVerifiedAt parameter to updateUser (#828)

v3.2.1

August 18, 2023

Changed

Updated group types for DsyncGroupUser* events to include full group object (#826)

v3.2.0

August 17, 2023

Added

Added enrollUserInMfaFactor method (#824)

Changed

Renamed authenticateUserWithToken to authenticateUserWithCode (#820)

v3.1.1

August 16, 2023

Changed

Fixed an issue where some arguments for listConnections and listDirectories would not properly be serialized to the API (#822)

Simplified to the options for updateUser to be less restrictive (#821)

v3.1.0

August 14, 2023

Added

Surfaced rawData on GenericServerException. This allows accessing the error code or any other arbitrary data that is returned from the API. (#817)

Exported AutoPaginatable from the root level of the SDK (#818)

v3.0.0

August 11, 2023

This is a major release of the WorkOS API that will likely contain breaking changes for your application. In addition to new APIs, we also cleaned up many of the interfaces in our API to offer a more consistent developer experience. Please carefully read these release notes and contact support@workos.com if you encounter any issues.

Added

Added the new User Management APIs (#778)

Added createdAt and updatedAt fields to Directory User to match the Directory User in the webhooks (#733)

Changed

[Breaking Change] Migrated the SDK to consistently use camel case instead of snake case to work more naturally in the Node ecosystem. This change affects not only the options to interact with the SDK's functions but also the responses from the API and webhooks.

Audit Logs (#780)

Directory Sync (#781)

Events API (#782)

Magic Link (#792)

MFA (#784)

Organizations (#785)

SSO (#793)

Webhooks (#797)

[Breaking Change] Normalized the values returned by Directory.state to match the latest values on the platform and to be consistent with our webhooks. linked has been renamed to active and unlinked has been renamed to inactive. If you store these values in your systems you'll want to perform a migration to update them as well as any logic handling the state. (#812)

[Breaking Change] Renamed Connection.connection_type to Connection.type.

[Breaking Change] Migrated all list endpoints to allow for Auto Pagination. They now expose an autoPagination function that allows for iterating through all available pages on the endpoint without developers needing to write the iterating logic themselves (#788)

[Breaking Change] Renamed the Directory Sync User interface to DirectoryUser to match the rest of the platform and to clear up the User namespace (#774)

[Breaking Change] Renamed the Directory Sync Group interface to DirectoryGroup to remain consistent with the rest of the platform and with DirectoryUser (#775)

[Breaking Change] The Webhook interface was renamed to Event and consolidated with the interface of the Events API. Additionally, the responses from the Events API are now strongly typed (#801)

[Breaking Change] Directory.type now returns a DirectoryType instead of a string (#806)

[Breaking Change] Renamed the ListUserOptions interface to ListDirectoryUserOptions (#779)

[Breaking Change] Renamed the ListGroupOptions interface to ListDirectoryGroupOptions (#799)

Removed

Connection.status, which was previously deprecated in v0.10.2 has been removed. Use Connection.state instead (#798)

v2.20.0

June 26, 2023

Changed

Changed the Events API (in beta) rangeStart and rangeEnd parameters to range_start and range_end(#749)

v2.19.0

June 16, 2023

Added

Added Events API beta

v2.18.0

May 2, 2023

Added

Added actor_ids, and actor_names parameters to auditLogs.createExport method, deprecated actors (#729)

v2.17.0

February 16, 2023

Added

Added groups attribute to SSO user profile. This feature is in beta, please reach out to support@workos.com to access this feature. (#704)

Changed

Multiple dependency updates

v2.16.0

December 8, 2022

Added

Add log_streams Admin Portal intent (#691)

Changed

Security package updates (#688, #689, #690, #693, #695)

v2.15.1

November 30, 2022

Fixed

Added missing user, issuer, and uri properties to totp (#687)

v2.15.0

October 18, 2022

Added

Added success_url parameter to generate_link method (#670)

v2.14.0

October 12, 2022

Added

Added getPrimaryEmail method for directory users (#670)

Added job title attribute to directory users (#675)

Changed

Multiple dependency updates

v2.13.0

September 16, 2022

Added

Added support for creating Admin Portal links for viewing Audit Logs (#666)

Changed

Exposed additional methods from Webhooks class (#656)

Multiple dependency updates

v2.12.0

August 18, 2022

Added

Added support for passing idempotency keys to createOrganization (#655)

Added support for customizing Axios client (#657)

v2.9.1

July 15, 2022

Added

Exported audit log interfaces (#643)

v2.9.0

July 14, 2022

Added

Added organization_id to Directory User and Directory Group (#640)

v2.8.1

July 13, 2022

Changed

Fixed misleading 404 messages (#638)

v2.8.0

July 12, 2022

Changed

Added auditLogs modules (preview) (#636)

Updated endpoints used for MFA operations (#633)

v2.7.0

June 7, 2022

Changed

Added order param for pagination by (#614)

Added idp_id, created_at and updated_at fields to Directory Group interface (#622)

Made expires_at nullable in MFA challenge interface (#623)

Updated connection enum list and bumped version to 2.7.0 (#624)

v2.6.1

May 23, 2022

Fixed

Propagated code and message error properties for 422 responses

Fixed TS types for verifyFactor response