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

@spec challenge_factor(WorkOS.Client.t(), String.t(), map(), keyword()) ::
  {:ok, WorkOS.AuthenticationChallenge.t()} | {:error, WorkOS.Error.error()}

Challenge Factor

Creates a Challenge for an Authentication Factor.

Parameters

id — The unique ID of the Authentication Factor to be challenged.
params — request body map
opts — per-request options (see WorkOS.Client.request/5)

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

@spec create_user_auth_factor(WorkOS.Client.t(), String.t(), map(), keyword()) ::
  {:ok, WorkOS.UserAuthenticationFactorEnrollResponse.t()}
  | {:error, WorkOS.Error.error()}

Enroll an authentication factor

Enrolls a user in a new authentication factor.

Parameters

userland_user_id — The ID of the user.
params — request body map
opts — per-request options (see WorkOS.Client.request/5)

delete_factor(client, id, opts \\ [])

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

Delete Factor

Permanently deletes an Authentication Factor. It cannot be undone.

Parameters

id — The unique ID of the Factor.
opts — per-request options (see WorkOS.Client.request/5)

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

@spec enroll_factor(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.AuthenticationFactorEnrolled.t()}
  | {:error, WorkOS.Error.error()}

Enroll Factor

Enrolls an Authentication Factor to be used as an additional factor of authentication. The returned ID should be used to create an authentication Challenge.

Parameters

params — request body map
opts — per-request options (see WorkOS.Client.request/5)

get_factor(client, id, opts \\ [])

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

Get Factor

Gets an Authentication Factor.

Parameters

id — The unique ID of the Factor.
opts — per-request options (see WorkOS.Client.request/5)

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

@spec list_user_auth_factors(WorkOS.Client.t(), String.t(), map(), keyword()) ::
  {:ok, WorkOS.Page.t(WorkOS.AuthenticationFactor.t())}
  | {:error, WorkOS.Error.error()}

List authentication factors

Lists the authentication factors for a user.

Parameters

userland_user_id — The ID of the user.
params — query parameters: :before, :after_, :limit, :order
opts — per-request options (see WorkOS.Client.request/5)

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

@spec verify_challenge(WorkOS.Client.t(), String.t(), map(), keyword()) ::
  {:ok, WorkOS.AuthenticationChallengeVerifyResponse.t()}
  | {:error, WorkOS.Error.error()}

Verify Challenge

Verifies an Authentication Challenge.

Parameters

id — The unique ID of the Authentication Challenge.
params — request body map
opts — per-request options (see WorkOS.Client.request/5)