Aura.Users (Aura v0.9.1)
View SourceService module for interacting with a Aura.Model.HexUser
Summary
Functions
Requests a Hex user be created
Returns a Aura.Model.HexUser
representing the authenticated requester
Returns a Aura.Model.HexUser
, given their username_or_email
Resets a specified user's password
Returns a stream of Aura.Model.HexAuditLog
, scoped to the authenticated requester
Functions
@spec create_user( username :: Aura.Common.username(), password :: String.t(), email :: Aura.Common.email(), opts :: list() ) :: {:ok, Aura.Model.HexUser.t()} | {:error, any()}
Requests a Hex user be created
@spec get_current_user(opts :: list()) :: {:ok, Aura.Model.HexUser.t()} | {:error, any()}
Returns a Aura.Model.HexUser
representing the authenticated requester
@spec get_user( username_or_email :: Aura.Common.username() | Aura.Common.email(), opts :: list() ) :: {:ok, Aura.Model.HexUser.t()} | {:error, any()}
Returns a Aura.Model.HexUser
, given their username_or_email
@spec reset_user_password( username_or_email :: Aura.Common.username() | Aura.Common.email(), opts :: list() ) :: :ok | {:error, any()}
Resets a specified user's password
@spec stream_audit_logs(opts :: list()) :: Enumerable.t()
Returns a stream of Aura.Model.HexAuditLog
, scoped to the authenticated requester