specify the layout. Uses defaultLayout by default

Default destination on successful login, if no other destination exists.

Default destination on successful logout, if no other destination exists.

Perform authentication based on the given credentials.

Default implementation is in terms of getAuthId

@since: 1.4.4

Determine the ID associated with the set of credentials.

Default implementation is in terms of authenticate

Which authentication backends to use.

What to show on the login page.

By default this calls defaultLoginHandler, which concatenates plugin widgets and wraps the result in authLayout. Override if you need fancy widget containers, additional functionality, or an entirely custom page. For example, in some applications you may want to prevent the login page being displayed for a user who is already logged in, even if the URL is visited explicitly; this can be done by overriding loginHandler in your instance declaration with something like:

instance YesodAuth App where
    ...
    loginHandler = do
        ma <- lift maybeAuthId
        when (isJust ma) $
            lift $ redirect HomeR   -- or any other Handler code you want
        defaultLoginHandler

Used for i18n of messages provided by this package.

After login and logout, redirect to the referring page, instead of loginDest and logoutDest. Default is False.

When being redirected to the login page should the current page be set to redirect back to. Default is True.

Since: 1.4.21

Return an HTTP connection manager that is stored in the foundation type. This allows backends to reuse persistent connections. If none of the backends you're using use HTTP connections, you can safely return error "authHttpManager" here.

Called on a successful login. By default, calls addMessageI "success" NowLoggedIn.

Called on logout. By default, does nothing

Retrieves user credentials, if user is authenticated.

By default, this calls defaultMaybeAuthId to get the user ID from the session. This can be overridden to allow authentication via other means, such as checking for a special token in a request header. This is especially useful for creating an API to be accessed via some means other than a browser.

Since: 1.2.0

Called on login error for HTTP requests. By default, calls addMessage with "error" as status and redirects to dest.

runHttpRequest gives you a chance to handle an HttpException and retry The default behavior is to simply execute the request which will throw an exception on failure

The HTTP Request is given in case it is useful to change behavior based on inspecting the request. This is an experimental API that is not broadly used throughout the yesod-auth code base