View Source WorkOS.Passwordless (WorkOS SDK for Elixir v1.1.0)
Manage Magic Link API in WorkOS.
Summary
Functions
Creates a Passwordless Session for a Magic Link Connection
Emails a user the Magic Link confirmation URL, given a Passwordless session ID.
Functions
@spec create_session(WorkOS.Client.t(), map()) :: WorkOS.Client.response(WorkOS.Passwordless.Session.t())
Creates a Passwordless Session for a Magic Link Connection
Parameter options:
:type
- The type of Passwordless Session to create. Currently, the only supported value isMagicLink
. (required):email
- The email of the user to authenticate. (required):redirect_uri
- Optional parameter that a developer can choose to include in their authorization URL.:expires_in
- The number of seconds the Passwordless Session should live before expiring.:state
- Optional parameter that a developer can choose to include in their authorization URL.
@spec send_session(WorkOS.Client.t(), String.t()) :: WorkOS.Client.response(WorkOS.Passwordless.Session.Send)
Emails a user the Magic Link confirmation URL, given a Passwordless session ID.