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.
clientId
(https://github.com/workos/workos-node/pull/897)redirectURI
to redirectUri
https://github.com/workos/workos-node/pull/926Challenge
and ChallengeResponse
interfaces to reflect optional code
property (https://github.com/workos/workos-node/pull/911)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
developer
domain verification strategy to manual
https://github.com/workos/workos-node/pull/879authenticateWithTotp
method https://github.com/workos/workos-node/pull/856listAuthFactors
method https://github.com/workos/workos-node/pull/857ipAddress
and userAgent
https://github.com/workos/workos-node/pull/861verifyEmailCode
method to handle nested user object in return https://github.com/workos/workos-node/pull/853completePasswordReset
to resetPassword
and change response https://github.com/workos/workos-node/pull/854createPasswordResetChallenge
to sendPasswordResetEmail
https://github.com/workos/workos-node/pull/855enrollUserInMfaFactor
to enrollAuthFactor
https://github.com/workos/workos-node/pull/858sendMagicAuthCode
to take email rather than email_address https://github.com/workos/workos-node/pull/860listAuthFactors()
return https://github.com/workos/workos-node/pull/862DsyncGroupUser*
events to include full group object (#826)enrollUserInMfaFactor
method (#824)authenticateUserWithToken
to authenticateUserWithCode
(#820)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.
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)Connection.connection_type
to Connection.type
.autoPagination
function that allows for iterating through all available pages on the endpoint without developers needing to write the iterating logic themselves (#788)User
interface to DirectoryUser
to match the rest of the platform and to clear up the User
namespace (#774)Group
interface to DirectoryGroup
to remain consistent with the rest of the platform and with DirectoryUser
(#775)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)Directory.type
now returns a DirectoryType
instead of a string (#806)ListUserOptions
interface to ListDirectoryUserOptions
(#779)ListGroupOptions
interface to ListDirectoryGroupOptions
(#799)rangeStart
and rangeEnd
parameters to range_start
and range_end
(#749)Events
API betaactor_ids
, and actor_names
parameters to auditLogs.createExport
method, deprecated actors
(#729)user
, issuer
, and uri
properties to totp
(#687)success_url
parameter to generate_link
method (#670)organization_id
to Directory User and Directory Group (#640)code
and message
error properties for 422 responsesverifyFactor
response