Deprecated API: Magic Link has been replaced by the AuthKit Magic Auth API.
The Magic Link API can be used to add Passwordless Authentication to your app.
An object representing a passwordless authentication session.
const passwordlessSession = { object: 'passwordless_session', id: 'passwordless_session_01EHDAK2BFGWCSZXP9HGZ3VK8C', email: 'marcelina@example.com', expiresAt: '2020-08-13T05:50:00.000Z', link: 'https://auth.workos.com/passwordless/4TeRexuejWCKs9rrFOIuLRYEr/confirm', };
interface PasswordlessSessionCreate a Passwordless Session for a Magic Link Connection.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); const session = await workos.passwordless.createSession({ email: 'marcelina@example.com', type: 'MagicLink', });
Email a user the Magic Link confirmation URL.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.passwordless.sendSession( 'passwordless_session_01EHDAK2BFGWCSZXP9HGZ3VK8C', );
passwordlessParameters Returns object