ArkeAuth.Core.User (arke_auth v0.1.3)
Documentation for User
.
Link to this section Summary
Link to this section Functions
Link to this function
arke_from_attr()
Link to this function
base_parameters()
Link to this function
before_create(arke, unit)
Link to this function
before_delete(arke, unit)
Link to this function
before_load(data, arg2)
Link to this function
before_update(arke, unit)
Link to this function
before_validate(arke, unit)
Link to this function
check_password(user, pwd)
@spec check_password(user :: ArkeAuth.Core.Unit.t(), pwd :: String.t()) :: {:ok, ArkeAuth.Core.Unit.t()} | Arke.Utils.ErrorGenerator.t()
Check if the given password is right
parameters
Parameters
- user => %Arke.Core.Unit{} => user struct
- pwd => string => password to check
return
Return
{:ok, %Arke.Core.Unit{}}
Link to this function
groups_from_attr()
Link to this function
on_create(arke, unit)
Link to this function
on_delete(arke, unit)
Link to this function
on_load(data, persistence_fn)
Link to this function
on_update(arke, unit)
Link to this function
on_validate(arke, unit)
Link to this function
update_password(user, new_pwd)
@spec update_password(user :: ArkeAuth.Core.Unit.t(), new_pwd :: String.t()) :: {:ok, ArkeAuth.Core.Unit.t()} | Arke.Utils.ErrorGenerator.t()
Update the user password
parameters
Parameters
- user => %Arke.Core.Unit{} => user struct
- new_pwd => string => password to check
return
Return
{:ok, %Arke.Core.Unit{}}