Workos Node Versions Save

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

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)

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)

Added

• Added the emailVerifiedAt parameter to updateUser (#828)

Changed

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

Added

• Added enrollUserInMfaFactor method (#824)

Changed

• Renamed authenticateUserWithToken to authenticateUserWithCode (#820)

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)

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)

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 [email protected] 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)

Changed

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