Okapi Okapi

WorkOS API Magic Link API removal

Deprecated, no dateSubscribe to WorkOS APIShare

WorkOS deprecated the Magic Link API without a shutdown date. The deprecation affects requests made to POST /passwordless/sessions*. When removed, calls to these endpoints will fail, as Magic Link has been replaced by the AuthKit Magic Auth API.


Calls it hits

  • POST /passwordless/sessions*

What to use instead of these calls

Send a one-time code using POST /user_management/magic_auth and authenticate the user via POST /user_management/authenticate with the urn:workos:oauth:grant-type:magic-auth:code grant type. Adopting Magic Auth requires more than changing an identifier, as it belongs to AuthKit User Management and changes how the application manages users by storing them in WorkOS.

Magic Auth belongs to AuthKit User Management, which keeps the users in WorkOS: adopting it changes how the app manages users.

In WorkOS API's words

Magic Link has been replaced by the AuthKit Magic Auth API

WorkOS API, Announcement

Facts

API
WorkOS API api.workos.com
Kind
Removal
Takes effect
No date given yet
Calls after that day
Fail
Source
Announcement
Last updated
Verified
, against WorkOS API's own pages

Questions

When does this change take effect?

WorkOS API deprecated POST /passwordless/sessions* without giving a shutdown date yet.

Do these calls still work?

Yes, they still work: WorkOS API has not given a shutdown date yet.

How do I find the calls this hits in my code?

Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.


Is your code calling this?

Okapi finds the calls this change hits in your repo and opens the pull request with the fix.

Add to GitHub

Get notifications

Subscribe to WorkOS API

Hear about each breaking change WorkOS API announces, in your feed reader, calendar or Slack.

1What to follow

Provider
  • WorkOS API

2Where to get it

/breaking-changes/feed.xml

Paste it into Feedly, Inoreader, NetNewsWire or any reader. New changes show up as they're announced.