Web.Scim.Class.Auth

HTTP authentication support. Can be used with basic auth, token-based auth, or something else (though OAuth is likely not implementable with this API).

Documentation

class AuthTypes tag

Types used in authentication routines.

Associated Types

type AuthData tag

The type that the “Authorization” header will be parsed as. This info will be given to authCheck.

type AuthInfo tag

The result of performing authentication.

Can be () to handle just authorized/non-authorized, or something more complex – for instance, if the auth header provides a token that may or may not correspond to a particular organization, then the result could be the ID of that organization).

Instances

AuthTypes Mock

Defined in Web.Scim.Server.Mock

Associated Types

type AuthData Mock

type AuthInfo Mock

AuthTypes (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

Associated Types

type AuthData (TestTag id authData authInfo userExtra)

type AuthInfo (TestTag id authData authInfo userExtra)

class (AuthTypes tag, FromHttpApiData (AuthData tag)) => AuthDB tag m where

An interface that has to be implemented for a server to provide authentication.

Methods

authCheck :: Maybe (AuthData tag) -> ScimHandler m (AuthInfo tag)

Do authentication or throw an error in ScimHandler (e.g. unauthorized) if the provided credentials are invalid or don't correspond to any user.

Instances

AuthDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

authCheck :: Maybe (AuthData Mock) -> ScimHandler TestServer (AuthInfo Mock)