package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

Easy API library and tools

Install

Dune Dependency

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

Authors

Maintainers

F

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

Sources

2.1.0.tar.gz

md5=e1d03d141ef977fbd4521256c91431f1

sha512=51b0cc4e6afb0cd5ab55c0c40964946b79e0c2cc903b5d08c594292eec723a25e25463175d704c02fe559e2af5d95973514c248a603ad28ec0230c35ad2d6492

doc/ez_api.session_client/EzSessionClient/Make/argument-1-S/index.html

Parameter `Make.S`

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.