Copyright	(c) Frederick Pringle 2025
License	BSD-3-Clause
Maintainer	frederick.pringle@fpringle.com
Safe Haskell	None
Language	Haskell2010

Servant.API.Routes.Auth

Description

Here we define a very very basic type to represent authentication schemes.

Synopsis

Documentation

There are 2 variants:

"Basic" authentication: corresponds to the BasicAuth type. Construct with basicAuth.
"Custom" authentication: corresponds to the AuthProtect type. Construct with customAuth.

Instances details

ToJSON Auth Source #
Instance details Defined in Servant.API.Routes.Internal.Auth Methods toJSON :: Auth -> Value # toEncoding :: Auth -> Encoding # toJSONList :: [Auth] -> Value # toEncodingList :: [Auth] -> Encoding # omitField :: Auth -> Bool #
Show Auth Source #
Instance details Defined in Servant.API.Routes.Internal.Auth Methods showsPrec :: Int -> Auth -> ShowS # show :: Auth -> String # showList :: [Auth] -> ShowS #
Eq Auth Source #
Instance details Defined in Servant.API.Routes.Internal.Auth Methods (==) :: Auth -> Auth -> Bool # (/=) :: Auth -> Auth -> Bool #
Ord Auth Source #
Instance details Defined in Servant.API.Routes.Internal.Auth Methods compare :: Auth -> Auth -> Ordering # (<) :: Auth -> Auth -> Bool # (<=) :: Auth -> Auth -> Bool # (>) :: Auth -> Auth -> Bool # (>=) :: Auth -> Auth -> Bool # max :: Auth -> Auth -> Auth # min :: Auth -> Auth -> Auth #

Create a term-level representation of a "Basic" authentication scheme.

For example:

ghci> toJSON $ basicAuth @"user"
String "Basic user"

Create a term-level representation of a "Custom" authentication scheme, i.e. one that corresponds to Servant's AuthProtect combinator.

For example:

ghci> toJSON $ customAuth @"OnlyAdminUsers"
String "OnlyAdminUsers"