package ez_api

  1. Overview
  2. Docs
Easy API library and tools

Install 

dune-project
 Dependency

github.com Readme Changelog LGPL-2.1-only License Edit opam file Versions (8)

Authors

  1. C
    Cagdas Bozman <cagdas.bozman@ocamlpro.com>
  2. M
    Michael Laporte <michael.laporte@ocamlpro.com>
  3. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>
  4. M
    Maxime Levillain <maxime.levillain@ocamlpro.com>
  5. A
    Alain Mebsout <alain.mebsout@ocamlpro.com>

Maintainers

  1. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>

Sources

3.0.0.tar.gz
md5=9069f59ac83c958cedc90a25f24faa1e
sha512=4b066a759043e6704a9617bdc412d29f7ded058cb0e01eb3a8207f54b80bebb478bb98a96832e61b15d281bc8f132e1386459c563eb807a51c01324541fe28b2

doc/ez_api.server_session/EzSessionServer/Make/argument-1-S/SessionArg/index.html

Module S.SessionArg

See EzSession.TYPES.SessionArg

type user_id

User identifier, which generally is the same as login

type user_info

Associated to user information

val web_host : string option

Web host, that should be used in access control headers, if specified. If web_host isn't specified, then acces-control header in response will be set to '*' and authentication wwith cookies wouldn't work. Note : Cookies would be set by browser only if request's flag 'with_credentials' is set to true. Last one in turn, requires that "access-control-allow-origin" header by reponse returns something different from "*".

val user_id_encoding : user_id Json_encoding.encoding

Json encoding for user's id

val user_info_encoding : user_info Json_encoding.encoding

Json encoding for user's information

val rpc_path : string list

RPC path where authentication services like connect, login and logout would be placed.

val token_kind : [ `Cookie of string * int64 option | `CSRF of string ]

Describes two ways to store a token within a client request :

  • Stores as a cookie associated with the given cookie name and its max-age, if provided.
  • Stores as a CSRF header with the given name.