WorkOS.Passwordless (WorkOS SDK for Elixir v3.0.1)

Copy Markdown View Source

Magic Link passwordless sessions.

These endpoints are not part of the OpenAPI spec, so this module is hand-maintained rather than generated.

{:ok, session} =
  WorkOS.Passwordless.create_session(client, %{
    email: "user@example.com",
    type: "MagicLink"
  })

{:ok, _} = WorkOS.Passwordless.send_session(client, session.id)

Summary

Functions

create_session(client, params \\ %{}, opts \\ [])

Creates a passwordless session (POST /passwordless/sessions).

send_session(client, session_id, opts \\ [])

Emails the Magic Link for a session (POST /passwordless/sessions/:id/send).

Functions

create_session(client, params \\ %{}, opts \\ [])

@spec create_session(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.Passwordless.Session.t()} | {:error, WorkOS.Error.error()}

Creates a passwordless session (POST /passwordless/sessions).

Parameters

  • params — request body map. Required: :email, :type ("MagicLink"). Optional: :redirect_uri, :state, :expires_in.
  • opts — per-request options (see WorkOS.Client.request/5)

send_session(client, session_id, opts \\ [])

@spec send_session(WorkOS.Client.t(), String.t(), keyword()) ::
  {:ok, term()} | {:error, WorkOS.Error.error()}

Emails the Magic Link for a session (POST /passwordless/sessions/:id/send).