Make (p.sihl.0.1.1.doc.sihl.user.User.Service.Make)

sihl
- CHANGES
- README
- Library sihl
  - Sihl
- Library sihl.app
  - App
- Library sihl.authn
  - Authn
- Library sihl.authz
  - Authz
- Library sihl.cmd
  - Cmd
- Library sihl.configuration
  - Configuration
- Library sihl.core
  - Core
- Library sihl.data
  - Data
- Library sihl.email
  - Email
- Library sihl.http
  - Http
- Library sihl.log
  - Log
- Library sihl.message
  - Message
- Library sihl.middleware
  - Middleware
- Library sihl.queue
  - Queue
- Library sihl.schedule
  - Schedule
- Library sihl.server
  - Server
- Library sihl.session
  - Session
- Library sihl.storage
  - Storage
- Library sihl.token
  - Token
- Library sihl.user
  - User
- Library sihl.utils
  - Utils
- Library sihl.web
  - Web
- Sources

Parameters

module Log : Log.Service.Sig.SERVICE

module CmdService : Cmd.Service.Sig.SERVICE

module DbService : Data.Db.Service.Sig.SERVICE

module Repo : Sig.REPOSITORY

Signature

include Core.Container.SERVICE

Sourceval lifecycle : Core__.Core_container.Lifecycle.t

Sourceval add_user : User__.User_core.User.t -> Core.Ctx.t -> Core.Ctx.t

Sourceval require_user_opt : Core.Ctx.t -> User__.User_core.User.t option

Sourceval require_user : Core.Ctx.t -> User__.User_core.User.t

Source

val find_all : 
  Core.Ctx.t ->
  query:Data.Ql.t ->
  (User__.User_core.User.t list * Data.Repo.Meta.t) Lwt.t

Source

val find_opt : 
  Core.Ctx.t ->
  user_id:string ->
  User__.User_core.User.t option Lwt.t

Sourceval find : Core.Ctx.t -> user_id:string -> User__.User_core.User.t Lwt.t

Sourceval find_by_email : Core.Ctx.t -> email:string -> User__.User_core.User.t Lwt.t

Source

val find_by_email_opt : 
  Core.Ctx.t ->
  email:string ->
  User__.User_core.User.t option Lwt.t

Source

val update_password : 
  Core.Ctx.t ->
  ?password_policy:(string -> (unit, string) Result.t) ->
  user:User__.User_core.User.t ->
  old_password:string ->
  new_password:string ->
  new_password_confirmation:string ->
  unit ->
  (User__.User_core.User.t, string) Result.t Lwt.t

Source

val update_details : 
  Core.Ctx.t ->
  user:User__.User_core.User.t ->
  email:string ->
  username:string option ->
  User__.User_core.User.t Lwt.t

Source

val set_password : 
  Core.Ctx.t ->
  ?password_policy:(string -> (unit, string) Result.t) ->
  user:User__.User_core.User.t ->
  password:string ->
  password_confirmation:string ->
  unit ->
  (User__.User_core.User.t, string) Result.t Lwt.t

Set the password of a user without knowing the old password.

This feature is typically used by admins.

Source

val create_user : 
  Core.Ctx.t ->
  email:string ->
  password:string ->
  username:string option ->
  User__.User_core.User.t Lwt.t

Create and store a user.

Source

val create_admin : 
  Core.Ctx.t ->
  email:string ->
  password:string ->
  username:string option ->
  User__.User_core.User.t Lwt.t

Create and store a user that is also an admin.

Source

val register : 
  Core.Ctx.t ->
  ?password_policy:(string -> (unit, string) result) ->
  ?username:string ->
  email:string ->
  password:string ->
  password_confirmation:string ->
  unit ->
  (User__.User_core.User.t, string) Result.t Lwt.t

Create and store new user.

Provide password_policy to check whether the password fulfills certain criteria.

Source

val login : 
  Core.Ctx.t ->
  email:string ->
  password:string ->
  (User__.User_core.User.t, string) Result.t Lwt.t

Find user by email if password matches.