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 firstname.lastname@example.org if you encounter any issues.
ChallengeResponseinterfaces to reflect optional
If you're already using a beta version of the User Management API, contact us at email@example.com for a full changelog and assistance upgrading.
Full Changelog: https://github.com/workos/workos-node/compare/v3.9.0...v4.0.0
developerdomain verification strategy to
verifyEmailCodemethod to handle nested user object in return https://github.com/workos/workos-node/pull/853
resetPasswordand change response https://github.com/workos/workos-node/pull/854
sendMagicAuthCodeto take email rather than email_address https://github.com/workos/workos-node/pull/860
DsyncGroupUser*events to include full group object (#826)
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 firstname.lastname@example.org if you encounter any issues.
Directory.stateto match the latest values on the platform and to be consistent with our webhooks.
linkedhas been renamed to
unlinkedhas 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)
autoPaginationfunction that allows for iterating through all available pages on the endpoint without developers needing to write the iterating logic themselves (#788)
DirectoryUserto match the rest of the platform and to clear up the
DirectoryGroupto remain consistent with the rest of the platform and with
Webhookinterface was renamed to
Eventand consolidated with the interface of the Events API. Additionally, the responses from the Events API are now strongly typed (#801)
Directory.typenow returns a
DirectoryTypeinstead of a string (#806)
log_streamsAdmin Portal intent (#691)
organization_idto Directory User and Directory Group (#640)
messageerror properties for 422 responses