AshAuthentication.Strategy.Otp.Actions (ash_authentication v5.0.0-rc.8)

Copy Markdown View Source

Actions for the OTP strategy.

Provides the code interface for working with user resources for OTP authentication.

Summary

Functions

request(strategy, params, options)

Request an OTP code for a user.

sign_in(strategy, params, options)

Attempt to sign a user in via OTP code.

Functions

request(strategy, params, options)

@spec request(AshAuthentication.Strategy.Otp.t(), map(), keyword()) ::
  :ok | {:error, any()}

Request an OTP code for a user.

sign_in(strategy, params, options)

@spec sign_in(AshAuthentication.Strategy.Otp.t(), map(), keyword()) ::
  {:ok, Ash.Resource.record()}
  | {:error, AshAuthentication.Errors.AuthenticationFailed.t()}

Attempt to sign a user in via OTP code.